pygwb.parameters.ParametersHelp

class pygwb.parameters.ParametersHelp(value)[source]

Bases: Enum

Description of the arguments in the Parameters class.

Notes

This is an enumeration class and is not meant for user interaction.

__init__(*args, **kwargs)

classmethod __call__(value, names=None, *, module=None, qualname=None, type=None, start=1)

Either returns an existing member, or creates a new enum class.

This method is used both when an enum class is given a value to match to an enumeration member (i.e. Color(3)) and for the functional API (i.e. Color = Enum(‘Color’, names=’RED GREEN BLUE’)).

When used for the functional API:

value will be the name of the new class.

names should be either a string of white-space/comma delimited names (values will start at start), or an iterator/mapping of name, value pairs.

module should be set to the module this class is being created in; if it is not set, an attempt to find that module will be made, but if it fails the class will not be picklable.

qualname should be set to the actual location this class can be found at in its module; by default it is set to the global scope. If this is not correct, unpickling will fail in some circumstances.

type, if set, will be mixed in as the first base class.

Attributes

`t0`
`tf`
`interferometer_list`
`data_type`
`channel`
`frametype`
`new_sample_rate`
`input_sample_rate`
`cutoff_frequency`
`segment_duration`
`number_cropped_seconds`
`window_downsampling`
`ftype`
`frequency_resolution`
`polarization`
`alpha`
`fref`
`flow`
`fhigh`
`local_data_path`
`notch_list_path`
`coarse_grain_psd`
`coarse_grain_csd`
`overlap_factor_welch`
`N_average_segments_psd`
`window_fft_dict`
`window_fft_dict_welch`
`calibration_epsilon`
`overlap_factor`
`delta_sigma_cut`
`alphas_delta_sigma_cut`
`save_data_type`
`time_shift`
`path_gate_data`
`gate_data`
`gate_tzero`
`gate_tpad`
`gate_threshold`
`cluster_window`
`gate_whiten`
`tag`
`return_naive_and_averaged_sigmas`
`help`
`argument`