virushealth.h File Reference

Data Structures

• struct CommonCheckOptions

  Options for the header check VHC command line options. More...
  

• class VirusHealth

  Virus Health check routines. More...
  

Defines

• #define LTL_RANGE_CHECKING

Enumerations

• enum vh {
    bias = 1, arc, flat, hetdex_dithers,
    virus, unknown
  }

  Enum with the various VHC check recipes.

  More...
  

Functions

• void add_common_options (OptionParser &flags, CommonCheckOptions &opts)

  Add common command line options.
  

• bool check_common_options (const CommonCheckOptions &opts)

  Check the common command line options.
  

---

Define Documentation

#define LTL_RANGE_CHECKING

Virus Health check routines.

---

Enumeration Type Documentation

enum vh

Enumerator:

bias	HETDEX bias frames.
arc	HETDEX arc line frames.
flat	HETDEX twilight/dome flat frames.
hetdex_dithers	Dithered HETDEX science observation.
virus	General VIRUS observation.
unknown	End marker to check for valid enum members.

---

Function Documentation

void add_common_options	(	OptionParser &	flags,
		CommonCheckOptions &	opts
	)

Add command line options for common HETDEX header keyword checks.

Add flags:

`-N, --npixels` to check the number of pixels in the image.

`-K, --keywords` to check the presence of required keywords.

`-O, --overscan` to check the image overscan rms.

`--ovc_sttdev` to set the expected standard deviation in the overscan.

`--ovc_mean` to set the expected mean of the overscan.

`--max_ovc_dev_mean` to set the maximum relative deviation allowed from the expected mean of the overscan.

`--max_ovc_dev_rms` to set the maximum relative deviation allowed from the expected standard deviation of the overscan.

`-E, --exptime` to check the exposure time depending on the image type recipe.

Parameters:

	flags	The util::OptionParser objects to add the flags to.
	opts	The CommonCheckOptions() structure to use for the Options.

References CommonCheckOptions::chk_exptime, CommonCheckOptions::chk_keywords, CommonCheckOptions::chk_npixels, CommonCheckOptions::chk_overscan, CommonCheckOptions::maxdev_ovc_mean, CommonCheckOptions::maxdev_ovc_rms, CommonCheckOptions::overscan_mean, CommonCheckOptions::overscan_stddev, CommonCheckOptions::verbose, and CommonCheckOptions::write_file.

Referenced by main().

bool check_common_options

(

const CommonCheckOptions &

opts

)

Check the common command line options. If a given option requires another option to be set, this check will fail, an error message printed and false returned.

Parameters:

opts

CommonCheckOptions() options structure.

Returns:

bool: true if the check succeeded, false otherwise.

Referenced by main().