This page was created by the IDL library routine `mk_html_help2`.

Last modified: Mon Aug 25 17:03:11 2025.

# Directory Listing of Routines

# projects/themis/ground/asi_mosaic

- THM_ASI_IMAGER_READFILE
- THM_GBO_SITE_LIST
  INPUT:
- SYNTAX:[2]
  INPUT:
- SYNTAX:[1]
  INPUT:
- SYNTAX:[2]
  INPUT:
- SYNTAX:[3]
  INPUT:
- SYNTAX:[4]
  INPUT:
- SYNTAX:[5]
  INPUT:
- SYNTAX:[6]
  INPUT:
- SYNTAX:[7]
  INPUT:
- SYNTAX:[8]
  INPUT:
- THM_REGO_ARRAY

# Routine Descriptions

## SYNTAX:[1]

[Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32990 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_add_asi_fovs.pro $

(See projects/themis/ground/asi_mosaic/thm_map_add_asi_fovs.pro)

## SYNTAX:[2]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32990 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_add_gb_sites.pro $

(See projects/themis/ground/asi_mosaic/thm_map_add_gb_sites.pro)

## SYNTAX:[2]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32990 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_add.pro $

(See projects/themis/ground/asi_mosaic/thm_map_add.pro)

## SYNTAX:[3]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32990 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_add_site_fieldofview.pro $

(See projects/themis/ground/asi_mosaic/thm_map_add_site_fieldofview.pro)

## SYNTAX:[4]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32990 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_gc_bjackel.pro $

(See projects/themis/ground/asi_mosaic/thm_map_gc_bjackel.pro)

## SYNTAX:[5]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 08:57:41 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32989 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_oplot_aacgm_2000_invariants.pro $

(See projects/themis/ground/asi_mosaic/thm_map_oplot_aacgm_2000_invariants.pro)

## SYNTAX:[6]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 08:57:41 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32989 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_oplot_geographic_grid.pro $

(See projects/themis/ground/asi_mosaic/thm_map_oplot_geographic_grid.pro)

## SYNTAX:[7]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:
       2015-05-22 - af - don't reset window if /noerase set, updating (some) documentation
     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 08:57:41 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32989 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_map_set.pro $

(See projects/themis/ground/asi_mosaic/thm_map_set.pro)

## SYNTAX:[8]

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY: Original version Eric Donovan and Brian Jackel
              2007-02-10, hfrey, extend for cdf-files and tplot
              2007-03-15, hfrey, thumbnails
              2008-04-28, hfrey, run full full_minute with pgm
              2018-11-19, hfrey, updated calibration files

     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32990 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_mosaic_array.pro $

(See projects/themis/ground/asi_mosaic/thm_mosaic_array.pro)

## THM_ASI_IMAGER_READFILE

[Previous Routine] [Next Routine] [List of Routines]

     NAME:    thm_asi_Imager_Readfile

     PURPOSE: This is intended to be a general tool for reading THEMIS-GBO imager data.
              At the moment it only deals with PGM files and has only been lightly
              tested on full (256x256) and row2 (376x1) frames.

     CATEGORY: Themis, Imager, File reading

     CALLING SEQUENCE:  THM_ASI_IMAGER_READFILE,Filename,Images,[Metadata]

     INPUTS: Filename  a string or array of strings containing valid image filenames
                       or wildcard search expressions as used in "findfile".

     KEYWORDS: COUNT      returns the number of image frames
               ALL_METADATA    set to obtain more metadata, much slower (default=0)
               DEBUG      set to increase verbosity (default=0)

     OUTPUTS: Images     a WIDTH x HEIGHT x NFRAMES array of unsigned integers or bytes
              Metadata     a NFRAMES element array of structures

     RESTRICTIONS: TBD

     EXAMPLES:

     Get one file, watch frames as movie

      filename="20051225_1100_whit_themis07_full.pgm.gz"
      THM_ASI_IMAGER_READFILE,filename,images,metadata,COUNT=nframes
      FOR indx=0,nframes-1 DO TVSCL,images[*,*,indx]

     Get 1 hour of data, summarize and display as keogram

      directory="\\themis-data\data\themis\imager\stream0\2005\12\25\whit_themis07\ut11\"
      THM_ASI_IMAGER_READFILE,directory+"*full.*",images,metadata,COUNT=nframes,/DEBUG
      keogram= TRANSPOSE(TOTAL(images[96:159,*,*],1))
      TVSCL,keogram,ORDER=1

     NOTES:

      PGM format is described on NetPBM home page at http://netpbm.sourceforge.net

      gzipped files (*.pgm.gz) can be read directly in IDL, bzip2 cannot

      early data (eg. ATHA 2004) were in PNG format with 1 frame per file

     MODIFICATION HISTORY:
      2006-03-09 Bjj assembly and preliminary documentation

     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32990 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_asi_imager_readfile.pro $

(See projects/themis/ground/asi_mosaic/thm_asi_imager_readfile.pro)

## THM_GBO_SITE_LIST

[Previous Routine] [Next Routine] [List of Routines]

     NAME:      thm_gbo_site_list
     SYNTAX:
     PURPOSE:
     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY:   original from Donovan
                2007-03-16, hfrey update to local THEMIS dir

     VERSION:
       $LastChangedBy: nikos $
       $LastChangedDate: 2024-12-13 08:57:41 -0800 (Fri, 13 Dec 2024) $
       $LastChangedRevision: 32989 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_gbo_site_list.pro $

(See projects/themis/ground/asi_mosaic/thm_gbo_site_list.pro)

## THM_REGO_ARRAY

[Previous Routine] [List of Routines]

     NAME: thm_rego_array

     PURPOSE: read red line images for mosaic generation

     CATEGORY:
        None

     CALLING SEQUENCE:
        thm_rego_array,iyear_in,im1,id,ih,im,is,tgb_sites,img1,cor1,ele1,www1,n_sites

     INPUTS:
        iyear_in	year
        im1	month
        id		day
        ih		hour
        im		minute
        is		second
        tgb_sites  sites to show

     OPTIONAL INPUTS:
        None

     KEYWORD PARAMETERS:
        verbose	print debug messages
        cal_files	provide or read calibration files
        thumb	thumbnail instead of full resolution
        show	which sites to show
        exclude	which sites to exclude
        insert	stop before exiting program

     OUTPUTS:
        img1	images
        cor1	corner coordinates
        ele1	pixel elevation angles
        www1	pixel imaged or not
        n_sites	number of sites found

     OPTIONAL OUTPUTS:
        None

     COMMON BLOCKS:
        None

     SIDE EFFECTS:
        None

     RESTRICTIONS:
        None

     EXAMPLE:

     SEE ALSO:

     MODIFICATION HISTORY:
        Written by: Harald Frey, Date: 2015-07-16
                    Original version Eric Donovan and Brian Jackel
                    (c) Eric Donovan and Brian Jackel - 2007
              2007-02-10, hfrey, extend for cdf-files and tplot
              2007-03-15, hfrey, thumbnails
              2008-04-28, hfrey,
              2015-07-16, hfrey, modified for red line images

     NOTES:

     VERSION:
     $LastChangedBy: nikos $
     $LastChangedDate: 2024-12-13 09:03:48 -0800 (Fri, 13 Dec 2024) $
     $LastChangedRevision: 32990 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/asi_mosaic/thm_rego_array.pro $

(See projects/themis/ground/asi_mosaic/thm_rego_array.pro)