Time Series Object

class z2n.series.Series()

A class to represent a time series object.

Attributes

  • bak : str

    A string that represents the backup file path.

  • gauss : str

    A series object that represents the gaussian fit.

  • input : str

    A string that represents the input file path.

  • output : str

    A string that represents the output file name.

  • format : str

    A string that represents the file format.

  • time : np.array

    An arrray that represents the time series.

  • bins : np.array

    An arrray that represents the frequency bins.

  • z2n : np.array

    An arrray that represents the periodogram.

  • harmonics : int

    An integer that represents the number of harmonics.

  • oversample : int

    An integer that represents the oversample factor.

  • fmin : float

    A float that represents the minimum frequency.

  • fmax : float

    A float that represents the maximum frequency.

  • delta : float

    A float that represents the frequency steps.

  • nyquist : float

    A float that represents the nyquist frequency.

  • exposure : float

    A float that represents the exposure period.

  • sampling : float

    A float that represents the sampling rate.

  • power : float

    A float that represents the peak power.

  • frequency : float

    A float that represents the peak frequency.

  • period : float

    A float that represents the peak period.

  • errorf : float

    A float that represents the frequency uncertainty.

  • errorp : float

    A float that represents the period uncertainty.

  • pulsed : float

    A float that represents the pulsed fraction.

Methods

get_bak(self)

Return the backup file path.

get_bins(self)

Return the frequency steps.

get_delta(self)

Return the frequency steps.

get_errorf(self)

Return the uncertainty of the frequency.

get_errorp(self)

Return the uncertainty of the period.

get_exposure(self)

Return the period of exposure.

get_fmax(self)

Return the maximum frequency.

get_fmin(self)

Return the minimum frequency.

get_format(self)

Return the file format.

get_frequency(self)

Return the peak frequency.

get_gauss(self)

Return the gaussian series object.

get_harmonics(self)

Return the number of harmonics.

get_input(self)

Return the input file path.

get_nyquist(self)

Return the nyquist frequency.

get_output(self)

Return the output file name.

get_oversample(self)

Return the oversample factor.

get_period(self)

Return the peak period.

get_periodogram(self)

Return the periodogram.

get_pfraction(self)

Return the pulsed fraction.

get_power(self)

Return the peak power.

get_sampling(self)

Return the sampling rate.

get_time(self)

Return the time series.

load_file(self)

Load a input file.

plot(self)

Plot the series and the parameters.

save_file(self)

Save a output file.

set_bak(self)

Change the backup file path.

set_bins(self)

Change the frequency steps.

set_delta(self)

Change the frequency steps.

set_errorf(self)

Return the uncertainty of the frequency.

set_errorp(self)

Return the uncertainty of the period.

set_exposure(self)

Change the period of exposure.

set_fmax(self)

Change the maximum frequency.

set_fmin(self)

Change the minimum frequency.

set_format(self)

Change the file format.

set_frequency(self)

Change the peak frequency.

set_gauss(self)

Copy the gaussian series object.

set_harmonics(self)

Change the number of harmonics.

set_input(self)

Change the input file path.

set_nyquist(self)

Change the nyquist frequency.

set_output(self)

Change the output file name.

set_oversample(self)

Change the oversample factor.

set_period(self)

Change the peak period.

set_periodogram(self)

Change the periodogram.

set_pfraction(self)

Change the pulsed fraction.

set_power(self)

Change the peak power.

set_sampling(self)

Change the sampling rate.

set_time(self)

Change the time series.