This page was created by the IDL library routine
mk_html_help. For more information on
this routine, refer to the IDL Online Help Navigator
or type:
? mk_html_help
at the IDL command line prompt.
Last modified: Fri Mar 24 12:48:46 2000.
NAME:
PURPOSE:
CATEGORY:
PIA - processing
CALLING SEQUENCE:
INPUT PARAMETERS:
KEYWORD PARAMETERS:
COMMON BLOCKS:
PROCEDURES USED:
PIA LIB:
ASTRO LIB:
INTERNAL:
MODIFICATION HISTORY:
Written by: J.Acosta (ISO-SOC/VILSPA) July 1998
V7.x
Expanding AAP output structure with DECP and RAP (CG) March 2000
V8.2
(See dyncal2aap.pro)
NAME:
ASSIGN_FLUX_DB
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
MODIFICATION HISTORY:
Written by: Jose Acosta (ISO SOC - VILSPA) May 1998
Version 7.1
(See assign_flux_db.pro)
NAME:
BUILD_LOTABLE
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
MODIFICATION HISTORY:
Written by: Jose Acosta (ISO SOC - VILSPA) May 1998
Version 7.1
(See build_lotable.pro)
NAME:
CALIB_CHOPPMEAS_SL
PURPOSE:
Direct calibration of chopped ISOPHOT-S measurements, includes
chopped SPRF plus first order correction.
CATEGORY:
PIA - processing
CALLING SEQUENCE:
CALIB_CHOPPMEAS_SL, sig_subt, flux_subt, flag, sprf_act $
[,/FIRST_CORR] [,/EXTRAPOLATE]
INPUT PARAMETERS:
sig_subt: array containing the signal to be calibrated
OUTPUT PARAMETERS:
flux_subt: signal calibrated in Jy
flag: flag containing 1 if signal are outside the calibrated range
sprf_act: Actual SPRF (optional)
KEYWORD PARAMETERS:
FIRST_CORR: Includes first order correction
EXTRAPOLATE: extrapolate first order correction if outside the
calibrated range. No effect if first_corr is not selected
COMMON BLOCKS:
phtslchopp
MODIFICATION HISTORY:
Written by: J. Acosta (IAC) Feb. 1999
V7.3
(See calib_choppmeas_sl.pro)
NAME:
CALIB_DYNSRD
PURPOSE:
Calibrate an input srd structure, given a list of calibrators per
pixels. It produces a temporary dyncal structure. It checks that
dark current was subtracted and the detector temperature is within
the calibrated range.
CATEGORY:
PIA - processing
CALLING SEQUENCE:
CALIB_DYNSRD, SRD, SELCAL_ADMN
INPUT:
SRD : PHTSRD temporary structure
SELCAL_ADMN : Array containing ADMNs for NCAL calibrators and each
pixel [NPIX,NCAL].
OUTPUTS:
DYNCAL : A PHTDYNCAL temporary structure.
KEYWORDS:
NEWHEADER : Modified header
VERBOSE : Set to obtain information about dyn. calibration details.
MODIFICATION HISTORY:
Written by: J.Acosta (ISO-SOC, VILSPA) August 1998
V7.x
(See calib_dynsrd.pro)
NAME:
COMBINE_DYNSRD
PURPOSE:
Combine different calibrators by different weightings
CATEGORY:
PIA - processing
CALLING SEQUENCE:
COMBINE_DYNSRD, tmpdyncal, avgcomb_flux, medcomb_flux, avgcomb_uflux, $
q1comb_flux, q3comb_flux, WEIGHT=weight, OFLAG= oflag
INPUT:
tmpdyncal : temporary dynamic calibration structure, as produce
by calib_dynsrd
KEYWORDS:
WEIGHT : Weighting mode [0: no weighting, 1: mean ratio,
OFLAG : Output flag indicating the quality of calibration
OUTPUTS:
avgcomb_flux : Combined average fluxes
medcomb_flux : Combined median fluxes
avgcomb_uflux : Uncertainty of combined average fluxes
q1comb_flux : First quartile of median fluxes
q3comb_flux : Third quartile of median fluxes
RESTRICTIONS:
MODIFICATION HISTORY:
Written by: J.Acosta (ESA/MPIA/IAC) July 1998
Version 7.x
(See combine_dynsrd.pro)
NAME:
COMBINE_DYNSRD_PIX
PURPOSE:
Combine different calibrators by different weightings, for a single pixel
CATEGORY:
PIA - processing
CALLING SEQUENCE:
COMBINE_DYNSRD_PIX, sig_ratio, weight, flave, flunc, comb_flave, $
comb_flunc, flmed, comb_flmed, comb_flmed_unc, UNC_RATIO = unc_ratio, $
NCAL_USE = ncal_use, MASK_RAT = mask_rat, COMBFLAG = combflag
INPUT:
sig_ratio : ratio of target to calibrator signals. It is usually
an array of dimension (NSIGNALS, NCAL_USE)
weight : Weighting mode [0: no weighting, 1: mean ratio,
2: uncertainty of calibrated flux]
flave : Calibrated mean flux
flunc : Uncertainty of calibrated mean flux
flmed : Calibrated median flux [optional]
KEYWORDS:
UNC_RATIO : The uncertainty of sig_ratio, dimensions should be
compatible
NCAL_USE : number of calibrators used, if not specified assume 1
MASK_RAT : Mask of sig_ratio, dimensions should be compatible
COMBFLAG : Output combination flag
weighted ratio abs(log(ratio)) flag
---------------------------------------------
r > 10, <0.1 >1 3
2<r<10 or 0.1<r<0.5 0.3<lr<1 2
1.5<r<2 or 0.5<r<0.67 0.18<lr<0.3 1
1<r<1.5 or 0.5<r<1 0<lr<0.18 0
OUTPUTS:
comb_flave : Combined flave
comb_flunc : uncertainty of Combined flave
comb_flmed : Combined flmed
comb_flmed_unc : uncertainty of combined flmed
RESTRICTIONS:
MODIFICATION HISTORY:
Written by: J.Acosta (ESA/MPIA/IAC) July 1998
Version 7.x
(See combine_dynsrd_pix.pro)
NAME:
DYNCAL_CLEAR
PURPOSE:
It clears the PHTDYNCAL structure, if no index is specified then it
will clear the whole structure
CATEGORY:
PIA - initialization
CALLING SEQUENCE:
DYNCAL_CLEAR
INPUT PARAMETERS:
None
KEYWORDS:
Index: If set, only those will be deleted from buffer
PROCEDURES USED:
Common Block(s) or @ procedure(s):
phtdyncal
MODIFICATION HISTORY:
Written by: J.Acosta (ESA/VILSPA-SAI) October 1998
V7.2
(See dyncal_clear.pro)
NAME:
FILL_DYNCAL
PURPOSE:
FILLS a temporary structure dyncal into the dynamic structure PHTDYNCAL
CATEGORY:
PIA - I/O
CALLING SEQUENCE:
FILL_DYNCAL, tmp [,newheader] [,REPLACE=replace]
INPUT:
tmp : DYNCAL like temporary structure
OPTIONAL INPUT:
newheader: New header to be change into the structure
KEYWORD:
REPLACE : IF set (different to 0) put structure into this PHTDYNCAL
position
RESTRICTIONS:
tmp must be a valid phtdyncal like temporary structure
PROCEDURES USED:
Common Block(s) or @ procedure(s):
phtdyncal
MODIFICATION HISTORY:
Written by: J. Acosta (ISO-SOC, Vilspa) July 1998
V7.x
(See fill_dyncal.pro)
NAME:
GET_RATSIG_PIX
PURPOSE:
Get the ratio of the signal of the target to a given calibrator,
including the flag for the target and the mask for the calibrator.
CATEGORY:
PIA - process
CALLING SEQUENCE:
GET_RATSIG, target_signal, target_flag, calib_sig, calib_mask, $
KEYWORD PARAMETERS:
NPIX: Number of pixels
NCAL: Number of calibrators to be used
COMMON BLOCKS:
phtacc_ratsig
RESTRICTIONS:
target_signal must be a vector [npix,nsignal] and tmpdyncal a
valid temporary dynamic cal structure
PROCEDURES USED:
PIA LIB:
decode_admn
ASTRO LIB:
avg
INTERNAL:
pixbutevent2
MODIFICATION HISTORY:
Written by: J.Acosta (ISO-SOC, VILSPA) August 1998
V7.x
(See get_ratsig.pro)
NAME:
GET_SIGUPTO
PURPOSE:
Get the index of signal up to where to discard, using the information
contained in a structure like phtacc_ratsig
CATEGORY:
PIA - process - signal selection
CALLING SEQUENCE:
MODIFICATION HISTORY:
Written by: J.Acosta (ISO-SOC, VILSPA) October 1998
V7.x
(See get_sigupto.pro)
NAME:
LOAD_CALIB_INUSE
PURPOSE:
Load information from the dynamic calibration database
CATEGORY:
PIA - Processing
CALLING SEQUENCE:
load_calib_inuse, admn_list, calinfo_str
MODIFICATION HISTORY:
Written by: Jose Acosta (ISO SOC - VILSPA) May 1998
Version 7.1
(See load_calib_inuse.pro)
NAME:
PHTACC
PURPOSE:
Define common block ACC for information about acceptance/discarding
of data points.
CATEGORY:
PIA - common block
CALLING SEQUENCE:
@phtacc_ratsig
COMMON BLOCK PARAMETERS:
MODIFICATION HISTORY:
Written by: Jose Acosta (ISO-SOC, Vilspa) Jul 98
Version 7.x
(See phtacc_ratsig_init.pro)
NAME:
PHTDYNCAL
PURPOSE:
Definition of the common block PHTDYNCAL (Dynamic calibration
structure) for inclusion into other routines.
CATEGORY:
PIA - common block
CALLING SEQUENCE:
@phtdyncal
MODIFICATION HISTORY:
Written by: Jose Acosta (ISO SOC - VILSPA) May 1998
dyncalib_first_handle, dyncalib_last_handle and phtdyncalib_desc added
Version 7.1
(See phtdyncal.pro)
NAME:
PHTDYNCALDB
PURPOSE:
Definition of the common block PHTDYNCALDB (Dynamic calibration
database) for inclusion into other routines.
CATEGORY:
PIA - common block
CALLING SEQUENCE:
@phtdyncaldb
MODIFICATION HISTORY:
Written by: Jose Acosta (ISO SOC - VILSPA) May 1998
dyncalib_first_handle, dyncalib_last_handle and phtdyncalib_desc added
Version 7.1
(See phtdyncaldb.pro)
NAME:
phtdyncaldb_init
PURPOSE:
Initializes the structure phtdyncaldb (dynamic calibration database)
defining the contents as a template structure phtdyncaldb_type
It can be used for clearing the whole structure, in case
this should show as necessary.
CATEGORY:
PIA - initialization
CALLING SEQUENCE:
@phtdyncaldb_init
COMMON BLOCKS:
phtdyncaldb
MODIFICATION HISTORY:
Written by: J.Acosta (ESA/ESTEC) May 1998
Version 7.1
(See phtdyncaldb_init.pro)
NAME:
phtdyncal_init
PURPOSE:
Initializes the structure phtdyncalib (dynamic calibration)
defining the contents as a template structure phtdyncalib_type
It can be used for clearing the whole structure, in case
this should show as necessary.
CATEGORY:
PIA - initialization
CALLING SEQUENCE:
@phtdyncalib_init
COMMON BLOCKS:
phtdyncalib
MODIFICATION HISTORY:
Written by: J.Acosta (ESA/ESTEC) May 1998
Version 7.1
(See phtdyncal_init.pro)
NAME:
PIA_def_dyncal
PURPOSE:
Simple widget I/F for defining the number of references and/or make
a selection of sources to be used in the dynamic calibration
CATEGORY:
PIA - graphics
CALLING SEQUENCE:
PIA_def_dyncal
COMMON BLOCKS:
phtdyncaldb
PROCEDURES USED:
none
MODIFICATION HISTORY:
Written by: J. Acosta (ISO-SOC, Vilspa) August 1998
Version 7.x
Code bug (not accepted by IDL5.3) corrected (CG) March 2000
V8.2
(See pia_def_dyncal.pro)
NAME:
PIA_DISPDYNCAL
PURPOSE:
Menu for PIA Dynamical Calibration Analysis intermediate level.
This routine should only be called by the PIA Display Data routine
and should not be called directly from the command line.
CATEGORY:
PIA - graphics
CALLING SEQUENCE:
PIA_DISPDYNCAL, dyncalps, srd, aapps, NV = NV, GROUP=group
INPUT PARAMETERS:
dyncalps: Position within the phtdyncal dynamycal structure
srd: Temporary SRD level structure
aapps: Position within the phtaap dynamycal structure
KEYWORD PARAMETERS:
GROUP: The group leader of the widget hirarchy
NV: Number of Views (1 <= NV <= 4)
COMMON BLOCKS:
adm
colour_indices
drift_not_acc
phtdyncal
phtaap
pia_driftmod_out
pia_dispdyncal_cmn (internal)
pia_dspchdyn_cmn (internal)
pia_dspchz_cmn
pia_widget_info
PROCEDURES USED:
PIA LIB:
pia_xplot
pia_showstr
pia_disp_hdr
pia_disp_cs
pia_disp_isr
pia_disp_stat
pia_dispaap
ASTRO LIB:
INTERNAL:
drft_showpar
pixbuteventd
viewevent_dyncal
zoomevent_dyncal
zoomsync_dyncal
zoomnsync_dyncal
pia_resetview_dyncal
pia_dispdyncal_event
MODIFICATION HISTORY:
Written by: J.Acosta (ESA/VILSPA-SAI) September 1998
Minor correction concerning flags (JA) January 1999
Replacing numbers by letters in pixel ind. (Jacosta) March 2000
V8.2
(See pia_dispdyncal.pro)
NAME:
PIA_DISPSRD
PURPOSE:
Menu for PIA SRD Data display.
This is a fourth level menu in the PIA hierarchy.
This routine should only be called by the PIA Display Data routine
and should not be called directly from the command line.
CATEGORY:
PIA - graphics
CALLING SEQUENCE:
PIA_DISPSRD
KEYWORD PARAMETERS:
GROUP: The group leader of the widget hirarchy
DATA: An element of the PHTSRD dynamical structure
NV: Number of Views (1 <= NV <= 4)
REDRAW: To redraw same data
COMMON BLOCKS:
adm
colour_indices
phtacc
phtcs
phtdarkcur
phtsrd
pia_drift_inipar_cmn
pia_dspsrd_cmn (internal)
pia_dspch2_cmn (internal)
dspsrd_widg (internal)
pia_dspchz_cmn (internal)
not_acc (internal)
tmpvalues2 (internal)
dispcust_cmn (internal)
srdtext (internal)
pia_widget_info (internal)
RESTRICTIONS:
DATA must be a valid element of PHTSRD dynamical structure
PROCEDURES USED:
PIA LIB:
decode_admn
deglitch_change
do_deglitch
get_convwh
get_pht_hk
pia_dis2srd
pia_disp_cs
pia_disp_hdr
pia_dispcust
pia_dispscp
pia_drift_inipar
pia_load_isrd
pia_mann
pia_multchoice
pia_multmeas
pia_oplot
pia_pixchoice
pia_plot
pia_pubplot
pia_showstr
pia_sigdisc
pia_sm
pia_write_isrd
pia_xplot
pickmeas
process_tmpsrd
write_srd
xdisp_hk
ASTRO LIB:
avg
avg
fxpar
sigma
INTERNAL:
pixbutevent2
viewevent2
printevent2
stabil_par
deglitch_par
averagechop2
averagenonch2
averageevent2
medianchop2
mediannonch2
medianevent2
zoomevent2
zoomfourier2
zoomsync2
zoomnsync2
printit2
zoomit2
pia_resetview2
pia_dsrd_event
MODIFICATION HISTORY:
Written by: C.Gabriel (ESA/ESTEC) July 1994
Modified (last) by JAcosta - CGabriel February 97
Call to Deglitching routines modified to include
discarding flags (JA) March 97
V6.1
Graphical signal discarding added +
reset interval correction added +
saving internal file upgraded +
direct discrimination for measurement selection +
auxiliary files display added (EOH*, OLR) (CG) May 1997
Added button to reset RPID (JAcosta) June 1997
V6.3
Uncertainties from reset int corr added (CG) September 1997
Allowing for graph. multi de(re)-selection (CG) September 1997
V6.5
Added possibility to save corrections in phtsrd
buffer + calling sequence to pia_dispscp (JAc) October 1997
Orbital position dependant dark current
subtraction added (CG) December 1997
V6.6
Allowing external v. for reset int.corr (CG) February 1998
V7.0
(See pia_dispsrd_jmod.pro)
NAME:
PIA_disp_calid
PURPOSE:
Displays calibrator identificator for dynamic calibration
CATEGORY:
PIA - graphics
CALLING SEQUENCE:
PIA_disp_calid, tmpdyncal
INPUT PARAMETERS:
tmpdyncal: A static phtdyncal structure
KEYWORD PARAMETERS:
GROUP=group: Group leader
COMMON BLOCKS:
@phtdyncaldb
PROCEDURES USED:
PIA:
pia_disp_print_file
MODIFICATION HISTORY:
Written by: J. Acosta (ISO-SOC, Vilspa) Jul.98
V7.x
(See pia_disp_calid.pro)
NAME:
PIA_LOAD_IDYNCAL
PURPOSE:
Write a PHT-DYNCAL (Signal per chopper plateau) measurement from the
dynamic structure PHTDYNCAL (PHTDRIFT type) onto a temporary structure
CATEGORY:
PIA - processing
CALLING SEQUENCE:
PIA_LOAD_IDRIFT, driftdat, tmpdrift
INPUT:
DRIFTDAT : PHTDRIFT like dynamic structure
KEYWORDS:
none
OUTPUTS:
TMPDRIFT : A temporary structure of SCP type
RESTRICTIONS:
DRIFTDAT must exist
MODIFICATION HISTORY:
Written by: J.Acosta (ESA/MPIA/IAC) July 1998
Version 7.x
(See pia_load_idyncal.pro)
MODIFICATION HISTORY:
Written by: J. Acosta (ISO-SOC, Vilspa) August 1998
Version 7.x
(See pia_presel_dyncal.pro)
NAME: PIA_SGRATDISC PURPOSE: Menu for PIA Signal ratio selection in dynamic calibration. CATEGORY: PIA - graphics CALLING SEQUENCE: PIA_SGRATDISC INPUTS: none KEYWORD PARAMETERS: GROUP The group leader of the widget hirarchy NSIG Number of ramps per chopper plateau OUTPUTS: none SIDE EFFECTS: Modifies the variables in phtacc for selection criteria COMMON BLOCKS: pia_sgratdisc_cmn for internal use phtacc_ratdisc selection parameters PROCEDURES USED: Internal: pia_sgratdisc_event MODIFICATION HISTORY: Written by: J.Acosta (IAC) Coping with MODAL type acc. to IDL>5.0 (CG) February 1999 V7.3.1
(See pia_sgratdisc.pro)
NAME:
READ_IDYNCAL
PURPOSE:
READ a PHTIDYNCAL (Interactive Signal per Chopper Plateau) file
into the dynamic structure PHTDYNCAL
CATEGORY:
PIA - I/O
CALLING SEQUENCE:
READ_IDYNCAL, NAME [, IPOS] [, PATH = PATH] [, ADMN = ADMN]
INPUT:
NAME : PHTDYNCAL-savefile name (*.IDYNCAL)
OPTIONAL INPUT:
PATH : path for the file
OPTIONAL OUTPUT:
IPOS : index within phtdyncal array
OUTPUT KEYWORD:
ADMN : administration name (phtdyncal.admn)
RESTRICTIONS:
NAME must be a valid PHTISCP file
PROCEDURES USED:
Common Block(s) or @ procedure(s):
phtdyncal
MODIFICATION HISTORY:
Written by: J. Acosta (ISO-SOC, Vilspa) July 1998
V7.x
(See read_idyncal.pro)
NAME:
WRITE_IDRIT
PURPOSE:
Write a PHTDYNCAL (Dynamic Calibration Data) measurement from the dynamic
structure PHTDYNCAL onto an IDL savefile
CATEGORY:
PIA - I/O
CALLING SEQUENCE:
WRITE_IDYNCAL, PHTDYNCAL_INDEX, PATH = path, FNAME = fname, $
TMPDYNCAL = tmpdyncal
INPUT:
PHTDYNCAL_INDEX : Index of the measurement within PHTDYNCAL
OUTPUT:
IDL save file
RESTRICTIONS:
PHTDYNCAL(PHTDYNCAL_INDEX) must exist, if not TMPDYNCAL should be
a valid phtdyncal static structure
PROCEDURES USED:
Common Block(s) or @ procedure(s):
phtdyncal
MODIFICATION HISTORY:
Written by: J. Acosta
Jul 98 Version 7.x
(See write_idyncal.pro)