lalsimulation.gwsignal.core.conditioning_subroutines Namespace Reference

Functions
def	high_pass_time_series (time_series, dt, fmin, attenuation, N)
	High-pass a time series. More...
def	time_array_condition_stage1 (hp, hc, dt, t_extra, fmin)
	Stage 1 of time-series conditioning - add taper and high-pass the time-series. More...
def	time_array_condition_stage2 (hp, hc, dt, fmin, fmax)
	Stage 2 of time-series conditioning - taper end of waveform based off maximum frequency. More...
def	resize_gwpy_timeseries (hp, start_id, new_length)
	Resize a given gwpy TimeSeries which has a given length and starts at a point specified by start_id. More...

Function Documentation

high_pass_time_series()

def lalsimulation.gwsignal.core.conditioning_subroutines.high_pass_time_series	(		time_series,
			dt,
			fmin,
			attenuation,
			N
	)

High-pass a time series.

Parameters

time_series : TimeSeries GwPy TimeSeries object dt : float Sampling value of time series fmin : float Minimum frequency for high-pass attenuation : float Attenuation value at low-freq cut-off N : float Order of butterworth filter

Definition at line 26 of file conditioning_subroutines.py.

time_array_condition_stage1()

def lalsimulation.gwsignal.core.conditioning_subroutines.time_array_condition_stage1	(		hp,
			hc,
			dt,
			t_extra,
			fmin
	)

Stage 1 of time-series conditioning - add taper and high-pass the time-series.

Parameters

hp : TimeSeries GwPy TimeSeries object hc : TimeSeries GwPy TimeSeries object dt : float Sampling value of time series t_extra : float Initial extra time for conditioning fmin : float Minimum frequency for high-pass

Definition at line 66 of file conditioning_subroutines.py.

time_array_condition_stage2()

def lalsimulation.gwsignal.core.conditioning_subroutines.time_array_condition_stage2	(		hp,
			hc,
			dt,
			fmin,
			fmax
	)

Stage 2 of time-series conditioning - taper end of waveform based off maximum frequency.

Parameters

hp : TimeSeries GwPy TimeSeries object hc : TimeSeries GwPy TimeSeries object dt : float Sampling value of time series fmin : float Minimum frequency for high-pass fmax : float Minimum frequency for high-pass

Definition at line 107 of file conditioning_subroutines.py.

resize_gwpy_timeseries()

def lalsimulation.gwsignal.core.conditioning_subroutines.resize_gwpy_timeseries	(		hp,
			start_id,
			new_length
	)

Resize a given gwpy TimeSeries which has a given length and starts at a point specified by start_id.

If start_id is negative, the timeseries will be padded on the left with that amount.

Parameters

hp : gwpy.TimeSeries TimeSeries that needs to be resized

start_id : int If positive, index at which TimeSeries will now start from. If negative, TimeSeries will be zero padded with that length on the left.

new_length : int Final length of output array. This will be done by clippling the end of the TimeSeries, if new_length is larger than len(hp[start_id:]); otherwise zero_pad on right

Returns

hp : gwpy.TimeSeries Resized gwpy.TimeSeries object.

Definition at line 169 of file conditioning_subroutines.py.