BACK PROJECTION CLASS DEFINITION $SSW/hessi/idl/image/hsi_bproj__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       BACK PROJECTION CLASS DEFINITION

 PURPOSE: 
       Provides data structures and methods to generate and retrieve
       back projection maps. The back projection class extends the
       class strategy_holder_passive. The back projection can be
       calculated using either of the annsec or the visibility
       modulation pattern. The startegy holder is passive because it
       just selects its strategy by listening to the modulation
       pattern object, which really decides which strategy (commanded
       by imaging_method) to use. 

       HSI_Bproj is just a container. The real work is done by the
       startegie, either hsi_bprj_annsec or hsi_ bproj_vismod, which
       are two classes extending the basic class hsi_bproj_strategy.

 CATEGORY:
       Imaging
 
 CONSTRUCTION: 
       o = HSI_BProj()

 INPUTS (CONTROL) PARAMETERS:
       none in that class. But look at hsi_bproj_strategy
      
 OUTPUTS (INFORMATION) PARAMETERS:
       defined in {hsi_bproj_info}:
       
       bproj_alg_available: lists the back projection algorithms
                            (i.e, objects) available.

 SOURCE OBJECT:
       HSI_Modul_Pattern
 
 DESTINATION OBJECTS:
       HSI_Modpat_Products, HSI_Image

 CALLS: ***
	HSI_BPROJ::INIT, HSI_BPROJ__DEFINE, HSI_MODUL_PATTERN
 SEE ALSO:
	http://hessi.ssl.berkeley.edu/software/reference.html
	HESSI Utility Reference, hsi_bproj_control, hsi_bproj_control__defin
	hsi_bproj_info__define, hsi_modul_pattern__define
 HISTORY:
       Release 6 development: introduction of normal, uniform, taper, and
                              spatial_frequency_weight keywords
       Release 3 development, August / September 1999, 
           A Csillaghy, csillag@ssl.berkeley.edu
       Based on the release 2 software of Richard Schwartz
       Fundamental developments by Richard Schwartz, GSFC


BE_TIME_TEST $SSW/hessi/idl/util/hsi_be_time_test.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       BE_TIME_TEST

 PURPOSE: 
       

 CATEGORY:
       
 
 CALLING SEQUENCE: 
       be_time_test, 

 INPUTS:
       

 OPTIONAL INPUTS: 
       None.

 OUTPUTS:
       None.

 OPTIONAL OUTPUTS:
       None.

 KEYWORDS: 
       None.

 COMMON BLOCKS:
       None.

 PROCEDURE:

 RESTRICTIONS: 
       None.

 SIDE EFFECTS:
       None.

 EXAMPLES:
       

 SEE ALSO:
 HISTORY:
       Version 1, February 23, 2002, 
           A Csillaghy, csillag@ssl.berkeley.edu


binned EVENTLIST CONTROL STRUCTURE INITIALIZATION $SSW/hessi/idl/util/hsi_binned_eventlist_control.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       binned EVENTLIST CONTROL STRUCTURE INITIALIZATION

 PURPOSE:
       This function creates a binnedrated eventlist control structure
       and initializes it with default values.

 CATEGORY:
       Utilities

 CALLING SEQUENCE:
       result = hsi_binned_eventlist_control()

 OUTPUT:
       result: a variable of type {hsi_binned_eventlist_control} with
               default values assigned to each tag.

 KEYWORDS:
       HARMONIC_MASK: a byte array of 27x5 elements allowing to
                      select which harmonic for which a2d_index must
                      be used. Default: harmonic_mask[0:8, 0] = 1
       HARMONIC_MAX: a int determining the max. harmonic to
                     use. Default: 1
       SASZERO: a byte allowing to shut off the sas/ras
                correction. Default: 0
       TIME_BIN_DEF: a array of 9 elements determining the bin size
                     of the binnedrated eventlist for the
                     corresponding detector. Default:
                     [512,1024,2048,4096,4096,8192,8192,16384,32768]
                     in binary microseconds.
       TIME_BIN_MIN: a value determining the smallest time bin. If
                     this is used, time_bin_def is (re)set according
                     to the following factors:
                     [1, 2, 4, 8, 8, 16, 16, 32, 64]
 PARENT STRUCTURE:
       HSI_EVENTLIST_CONTROL

 CALLS: ***
	HSI_BINNED_EVENTLIST_CONTROL, hsi_spectrogram_Control
  HISTORY:
           harmonic_max included. ACs.
       Rel. 3. development, August 1999
       Version 1, May 17, 1999,
           A Csillaghy, csillag@ssl.berkeley.edu
 19-oct-2001, ras, added det_index_mask
 20-nov-2001, ras, made det_index_mask explicit
   14-dec-2001, ras, energy_band is now a control param of this class.
 27-mar-2002, ras, intialize with spectrogram_control(), add dp_cutoff
   19-sep-2002, ras, move dp_cutoff to eventlist_strategy_control
 8-aug-03, ras - reconciling eb_index, im_energy_binning, energy_band
   15-apr-04, ras- add use_cull and cull_frac control parameter


binning $SSW/hessi/idl/objects/binning.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       binning()

 PURPOSE:
       wrapper around obj_new to create a binning object

 CATEGORY:
       utilities

 INSTANCE CREATION:
       o = binning()

 CALLED BY:
	binning__define
 SEE ALSO:
	binning__define
 HISTORY:
       01-feb-2004 - acs created
                     csillag@ssl.berkeley.edu


binning__define $SSW/hessi/idl/objects/binning__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       binning__define

 PURPOSE:
       this class provides the basic capabilities of dividing an
       interval into a number of sub-intervals, or "bins"

       you can divide the interval by specifying diverse parameters
       - the values of the center of the bins (the "mean")
       - the values of each bin edge, either with a 1-dimensional array
         (consecutive bins) or with a 2-dimensional array (non-consecutive bins)
       - the start of the interval, the width of the bins, and the
             number of elements

       this can (and is) used to define several kinds of axes, see
       time_axis__define or spectrum_axis__define

       The objects uses several strategies to understand how the
       interval must be divided.

 CATEGORY:
       utilities

 INSTANCE CREATION:
       o = binning()

 METHODS:
       o->set
       result = o->get()

 (KEYWORD) PARAMETERS:
       mean: the center of the bins
       width: the width of the bins
       edges: the edges of the bins. can be either 1d or 2d
       start_val: the start value of the interval
       end_val: the end value of the interval
       n_els: the number of elements within the interval

 EXAMPLES:
       see binning_test below

 CALLS: ***
	BINNING::CLEANUP, BINNING::GET, BINNING::GETSTATUS, BINNING::HELP, BINNING::INIT
	BINNING::SET, BINNING_TEST, EXIST, VALID_RANGE, axis_get_edges, binning
	get_edge_products, is_number [1], is_number [2]
 SEE ALSO:
 HISTORY:
       feb-2004 --- acs, lots of changes
       jan-2004 --- acs, binning__define as a class for itself (from axis__define)
       dec-2003 --- acs, separate display parameters from binning def. parameters
       Version 1, August 21, 2003,
           A Csillaghy, csillag@ssl.berkeley.edu