HMI_IQUV_averaging - derive Stokes vector I,Q,U, and V observables

Synopsis

HMI_IQUV_averaging begin= end= wavelength= quicklook= camid= cadence= lev1= npol= size= average= rotational= linearity=

HMI_IQUV_averaging creates 12-min or 96-min averaged Stokes vector I,Q,U, and V observables (WARNING: the output series names are built-in and the program should not be run without editing and recompiling except for production). The code outputs are level 1.5 DRMS records: Stokes vector I, Q, U, and V. The code produces these records for all the slotted times in the time interval provided by the user. HMI_IQUV_averaging can produce definitive or quick-look (near-real time, nrt) observables.

Depending on the values of the command-line arguments, the outputs of HMI_observables are put in different DRMS series. When the average is 12 minutes: For IQUV observables obtained from definitive level 1 records and from a standard observable sequence with a 135s cadence, the output DRMS series is hmi.S_720s. For IQUV observables obtained from quicklook/nrt level 1 records, the series is hmi.S_720s_nrt. When the average is 96 minutes (WARNING: THIS IS NOT A STANDARD OBSERVABLES PRODUCT, AND NO NRT SERIES IS CURRENTLY AVAILABLE): For IQUV observables obtained from definitive level 1 records and from a standard observable sequence with a 135s cadence, the output DRMS series is hmi.S_5760s.

Under normal operations, for the 12-min average, other DRMS modules (HMI_observables, hmi_segment_module and hmi_patch_module) using the output of HMI_IQUV_averaging are run immediately after completion of HMI_IQUV_averaging: for production these two modules should always be called after.

Options

Mandatory arguments:

• begin="time" where time is a string. This is the beginning time of the timespan for which observables are to be computed. Time is in JSOC (sprint_ut) format YYYY.MM.DD_hh:mm:ss{.sss}_TAI (HMI_IQUV_averaging uses the TAI time standard internally, therefore it is easier to also provide beginning and ending times in TAI).
• end="time" where time is a string. This is the ending time of the timespan for which observables are to be computed. Time is in JSOC (sprint_ut) format YYYY.MM.DD_hh:mm:ss{.sss}_TAI (HMI_IQUV_averaging uses the TAI time standard internally, therefore it is easier to also provide beginning and ending times in TAI).

Optional arguments:

• wavelength=number where number is an integer and is the filter index of the target wavelength. For an observables sequence with 6 wavelengths, with corresponding filter indices ranging from I0 to I5 (for filters nominally centered at +172 mA to -172 mA from the Fe I line central wavelength at rest), the first wavelength of the sequence is I3. Therefore, it is best to set wavelength to 3 (the value by default). This wavelength is used by HMI_IQUV_averaging as the reference one, for identifying the sequence run, for deciding how to group the level 1 filtergrams for the temporal averaging, and so on...
• quicklook=number where number is an integer equal to either 0 (for the production of definitive observables) or 1 (for the production of quicklook/nrt observables). The value by default is 0.
• camid=number where number is an integer equal to either 0 (to use input filtergrams taken by the side camera) or 1 (to use input filtergrams taken by the front camera). Currently, the IQUV observable sequence is taken on the side camera only, and therefore camid should be set to 0 (the value by default). The value of camid might be irrelevant for certain observables sequences that require combining both cameras (sequences currently not used).
• cadence=number where number is a float and is the cadence of the observable sequence in seconds. Currently, it should be set to 135 seconds for the IQUV observables (135.0 is the value by default).
• lev1="series" where series is a string and is the name of the DRMS series holding the level 1 records to be used by the observables code. For normal observables processing either of these two series should be used: hmi.lev1_nrt for the quicklook/nrt level 1 records, and hmi.lev1 for the definitive level 1 records. The value by default is hmi.lev1 (to be consistent with the default value of quicklook=0).
• npol=number where number is an integer and is the number of polarizations taken by the observables sequence. With the sequence currently run, npol should be set to 6 (the value by default).
• size=number where number is an integer and is the number of frames in the observables sequence. With the sequence currently run, size should be set to 36 (the value by default)
• average=number where number is an integer and is either 12 (the value by default) or 96 (WARNING: even though the code runs for 96-min averages, it has not yet been optimized for this value)
• rotational=number where number is an integer and is either 0 (the value by default) or 1. 1 means that the user wishes to use rotational flat fields instead of the standard pzt flat fields.
• linearity=number where number is an integer and is either 0 (the value by default) or 1. 1 means that the user wishes to correct for the non-linearity of the cameras.

Examples

Example 1:

To calculate definitive 12-min IQUV observables for the time range 2010.10.1_0:0:0_TAI to 2010.10.1_2:45:00_TAI:

HMI_IQUV_averaging begin="2010.10.1_0:0:0_TAI" end="2010.10.1_2:45:00_TAI" wavelength=3 quicklook=0 camid=0 cadence=720.0 lev1="hmi.lev1" npol=6 size=36

Example 2:

To calculate quicklook/nrt 12-min IQUV observables for the time range 2010.10.1_0:0:0_TAI to 2010.10.1_2:45:00_TAI:

HMI_IQUV_averaging begin="2010.10.1_0:0:0_TAI" end="2010.10.1_2:45:00_TAI" wavelength=3 quicklook=1 camid=0 cadence=720.0 lev1="hmi.lev1_nrt" npol=6 size=36

Versions

v 1.16: addition of command-line parameter "average" v 1.17: minor correction; Npol replaced by Npolin to avoid some rare occurences of segmentation faults v 1.18 and 1.19: code now aborts when status of drms_segment_read() or drms_segment_write() is not DRMS_SUCCESS v 1.20: possibility to apply a rotational flat field instead of the pzt flat field, and possibility to use smooth look-up tables instead of the standard ones support for the 8- and 10-wavelength observable sequences run in April 2010 v 1.21: correcting for non-linearity of cameras on May 1, 2015: code modified to run on FTSID=1022 (mod L observables sequence) on May 6, 2015: RSUNerr changed from 0.8 to 1.0 pixels on May 13, 2015: code modified to correct for higher front camera intensity when both cameras need to be combined on May 14, 2015: RSUNerr changed from 1.0 to 5.0 pixels (I'M TIRED OF INCREASING THE LIMIT INCREMENTALLY!!!!)

Synopsis

HMI_IQUV_averaging begin= end= wavelength= quicklook= camid= cadence= lev1= npol= size= average= rotational=

HMI_IQUV_averaging creates 12-min or 96-min averaged Stokes vector I,Q,U, and V observables (WARNING: the output series names are built-in and the program should not be run without editing and recompiling except for production). The code outputs are level 1.5 DRMS records: Stokes vector I, Q, U, and V. The code produces these records for all the slotted times in the time interval provided by the user. HMI_IQUV_averaging can produce definitive or quick-look (near-real time, nrt) observables.

Depending on the values of the command-line arguments, the outputs of HMI_observables are put in different DRMS series. When the average is 12 minutes: For IQUV observables obtained from definitive level 1 records and from a standard observable sequence with a 135s cadence, the output DRMS series is hmi.S_720s. For IQUV observables obtained from quicklook/nrt level 1 records, the series is hmi.S_720s_nrt. When the average is 96 minutes (WARNING: THIS IS NOT A STANDARD OBSERVABLES PRODUCT, AND NO NRT SERIES IS CURRENTLY AVAILABLE): For IQUV observables obtained from definitive level 1 records and from a standard observable sequence with a 135s cadence, the output DRMS series is hmi.S_5760s.

Under normal operations, for the 12-min average, other DRMS modules (HMI_observables, hmi_segment_module and hmi_patch_module) using the output of HMI_IQUV_averaging are run immediately after completion of HMI_IQUV_averaging: for production these two modules should always be called after.

Options

Mandatory arguments:

• begin="time" where time is a string. This is the beginning time of the timespan for which observables are to be computed. Time is in JSOC (sprint_ut) format YYYY.MM.DD_hh:mm:ss{.sss}_TAI (HMI_IQUV_averaging uses the TAI time standard internally, therefore it is easier to also provide beginning and ending times in TAI).
• end="time" where time is a string. This is the ending time of the timespan for which observables are to be computed. Time is in JSOC (sprint_ut) format YYYY.MM.DD_hh:mm:ss{.sss}_TAI (HMI_IQUV_averaging uses the TAI time standard internally, therefore it is easier to also provide beginning and ending times in TAI).

Optional arguments:

• wavelength=number where number is an integer and is the filter index of the target wavelength. For an observables sequence with 6 wavelengths, with corresponding filter indices ranging from I0 to I5 (for filters nominally centered at +172 mA to -172 mA from the Fe I line central wavelength at rest), the first wavelength of the sequence is I3. Therefore, it is best to set wavelength to 3 (the value by default). This wavelength is used by HMI_IQUV_averaging as the reference one, for identifying the sequence run, for deciding how to group the level 1 filtergrams for the temporal averaging, and so on...
• quicklook=number where number is an integer equal to either 0 (for the production of definitive observables) or 1 (for the production of quicklook/nrt observables). The value by default is 0.
• camid=number where number is an integer equal to either 0 (to use input filtergrams taken by the side camera) or 1 (to use input filtergrams taken by the front camera). Currently, the IQUV observable sequence is taken on the side camera only, and therefore camid should be set to 0 (the value by default). The value of camid might be irrelevant for certain observables sequences that require combining both cameras (sequences currently not used).
• cadence=number where number is a float and is the cadence of the observable sequence in seconds. Currently, it should be set to 135 seconds for the IQUV observables (135.0 is the value by default).
• lev1="series" where series is a string and is the name of the DRMS series holding the level 1 records to be used by the observables code. For normal observables processing either of these two series should be used: hmi.lev1_nrt for the quicklook/nrt level 1 records, and hmi.lev1 for the definitive level 1 records. The value by default is hmi.lev1 (to be consistent with the default value of quicklook=0).
• npol=number where number is an integer and is the number of polarizations taken by the observables sequence. With the sequence currently run, npol should be set to 6 (the value by default).
• size=number where number is an integer and is the number of frames in the observables sequence. With the sequence currently run, size should be set to 36 (the value by default)
• average=number where number is an integer and is either 12 (the value by default) or 96 (WARNING: even though the code runs for 96-min averages, it has not yet been optimized for this value)
• rotational=number where number is an integer and is either 0 (the value by default) or 1. 1 means that the user wishes to use rotational flat fields instead of the standard pzt flat fields.

Examples

Example 1:

To calculate definitive 12-min IQUV observables for the time range 2010.10.1_0:0:0_TAI to 2010.10.1_2:45:00_TAI:

HMI_IQUV_averaging begin="2010.10.1_0:0:0_TAI" end="2010.10.1_2:45:00_TAI" wavelength=3 quicklook=0 camid=0 cadence=720.0 lev1="hmi.lev1" npol=6 size=36

Example 2:

To calculate quicklook/nrt 12-min IQUV observables for the time range 2010.10.1_0:0:0_TAI to 2010.10.1_2:45:00_TAI:

HMI_IQUV_averaging begin="2010.10.1_0:0:0_TAI" end="2010.10.1_2:45:00_TAI" wavelength=3 quicklook=1 camid=0 cadence=720.0 lev1="hmi.lev1_nrt" npol=6 size=36

Versions

v 1.16: addition of command-line parameter "average" v 1.17: minor correction; Npol replaced by Npolin to avoid some rare occurences of segmentation faults v 1.18: possibility to apply a rotational flat field instead of the pzt flat field, and possibility to use smooth look-up tables instead of the standard ones support for the 8- and 10-wavelength observable sequences run in April 2010

Synopsis

HMI_IQUV_averaging_dcon begin= end= wavelength= quicklook= camid= cadence= lev1= npol= size= average= rotational= linearity=

HMI_IQUV_averaging_dcon creates 12-min or 96-min averaged Stokes vector I,Q,U, and V observables (WARNING: the output series names are built-in and the program should not be run without editing and recompiling except for production).

NOTE: this version, HMI_IQUV_averaging_dcon assumes a PSF deconvolved lev1 input and saves data into e.g. hmi_test.720s_dcon.

The code outputs are level 1.5 DRMS records: Stokes vector I, Q, U, and V. The code produces these records for all the slotted times in the time interval provided by the user. HMI_IQUV_averaging can produce definitive or quick-look (near-real time, nrt) observables.

Depending on the values of the command-line arguments, the outputs of HMI_observables are put in different DRMS series. When the average is 12 minutes: For IQUV observables obtained from definitive level 1 records and from a standard observable sequence with a 135s cadence, the output DRMS series is hmi_test.S_720s. For IQUV observables obtained from quicklook/nrt level 1 records, the series is hmi_test.S_720s_nrt. When the average is 96 minutes (WARNING: THIS IS NOT A STANDARD OBSERVABLES PRODUCT, AND NO NRT SERIES IS CURRENTLY AVAILABLE): For IQUV observables obtained from definitive level 1 records and from a standard observable sequence with a 135s cadence, the output DRMS series is hmi_test.S_5760s.

Under normal operations, for the 12-min average, other DRMS modules (HMI_observables, hmi_segment_module and hmi_patch_module) using the output of HMI_IQUV_averaging are run immediately after completion of HMI_IQUV_averaging: for production these two modules should always be called after.

Options

Mandatory arguments:

• begin="time" where time is a string. This is the beginning time of the timespan for which observables are to be computed. Time is in JSOC (sprint_ut) format YYYY.MM.DD_hh:mm:ss{.sss}_TAI (HMI_IQUV_averaging uses the TAI time standard internally, therefore it is easier to also provide beginning and ending times in TAI).
• end="time" where time is a string. This is the ending time of the timespan for which observables are to be computed. Time is in JSOC (sprint_ut) format YYYY.MM.DD_hh:mm:ss{.sss}_TAI (HMI_IQUV_averaging uses the TAI time standard internally, therefore it is easier to also provide beginning and ending times in TAI).

Optional arguments:

• wavelength=number where number is an integer and is the filter index of the target wavelength. For an observables sequence with 6 wavelengths, with corresponding filter indices ranging from I0 to I5 (for filters nominally centered at +172 mA to -172 mA from the Fe I line central wavelength at rest), the first wavelength of the sequence is I3. Therefore, it is best to set wavelength to 3 (the value by default). This wavelength is used by HMI_IQUV_averaging as the reference one, for identifying the sequence run, for deciding how to group the level 1 filtergrams for the temporal averaging, and so on...
• quicklook=number where number is an integer equal to either 0 (for the production of definitive observables) or 1 (for the production of quicklook/nrt observables). The value by default is 0.
• camid=number where number is an integer equal to either 0 (to use input filtergrams taken by the side camera) or 1 (to use input filtergrams taken by the front camera). Currently, the IQUV observable sequence is taken on the side camera only, and therefore camid should be set to 0 (the value by default). The value of camid might be irrelevant for certain observables sequences that require combining both cameras (sequences currently not used).
• cadence=number where number is a float and is the cadence of the observable sequence in seconds. Currently, it should be set to 135 seconds for the IQUV observables (135.0 is the value by default).
• lev1="series" where series is a string and is the name of the DRMS series holding the level 1 records to be used by the observables code. For normal observables processing either of these two series should be used: hmi.lev1_dcon_nrt for the quicklook/nrt level 1 records, and hmi.lev1_dcon for the definitive level 1 records. Or with hmi_test.lev1_dcon or hmi_test.lev1_decon_nrt. The value by default is hmi_test.lev1_dcon (to be consistent with the default value of quicklook=0).
• npol=number where number is an integer and is the number of polarizations taken by the observables sequence. With the sequence currently run, npol should be set to 6 (the value by default).
• size=number where number is an integer and is the number of frames in the observables sequence. With the sequence currently run, size should be set to 36 (the value by default)
• average=number where number is an integer and is either 12 (the value by default) or 96 (WARNING: even though the code runs for 96-min averages, it has not yet been optimized for this value)
• rotational=number where number is an integer and is either 0 (the value by default) or 1. 1 means that the user wishes to use rotational flat fields instead of the standard pzt flat fields.
• linearity=number where number is an integer and is either 0 (the value by default) or 1. 1 means that the user wishes to correct for the non-linearity of the cameras.

Examples

Example 1:

To calculate definitive 12-min IQUV observables for the time range 2010.10.1_0:0:0_TAI to 2010.10.1_2:45:00_TAI:

HMI_IQUV_averaging begin="2010.10.1_0:0:0_TAI" end="2010.10.1_2:45:00_TAI" wavelength=3 quicklook=0 camid=0 cadence=720.0 lev1="hmi_test.lev1_dcon" npol=6 size=36

Example 2:

To calculate quicklook/nrt 12-min IQUV observables for the time range 2010.10.1_0:0:0_TAI to 2010.10.1_2:45:00_TAI:

HMI_IQUV_averaging begin="2010.10.1_0:0:0_TAI" end="2010.10.1_2:45:00_TAI" wavelength=3 quicklook=1 camid=0 cadence=720.0 lev1="hmi_test.lev1_dcon_nrt" npol=6 size=36

Versions

v 1.16: addition of command-line parameter "average" v 1.17: minor correction; Npol replaced by Npolin to avoid some rare occurences of segmentation faults v 1.18 and 1.19: code now aborts when status of drms_segment_read() or drms_segment_write() is not DRMS_SUCCESS v 1.20: possibility to apply a rotational flat field instead of the pzt flat field, and possibility to use smooth look-up tables instead of the standard ones support for the 8- and 10-wavelength observable sequences run in April 2010 v 1.21: correcting for non-linearity of cameras on May 1, 2015: code modified to run on FTSID=1022 (mod L observables sequence) on May 6, 2015: RSUNerr changed from 0.8 to 1.0 pixels on May 13, 2015: code modified to correct for higher front camera intensity when both cameras need to be combined on May 14, 2015: RSUNerr changed from 1.0 to 5.0 pixels (I'M TIRED OF INCREASING THE LIMIT INCREMENTALLY!!!!)