nenupy.observation.obs_config.PulsarFoldConfig

class nenupy.observation.obs_config.PulsarFoldConfig(_setFromParset=False, **kwargs)[source]

Bases: _UnDySPuTeDConfig

UnDySPuTeD Pulsar-FOLD mode observation configuration.

Parameters:
  • nSubBands (int) – Number of sub-bands (min: 1, max: 192, default: 192).

  • nPolars (int) – Number of polarizations (min: 1, max: 4, default: 4).

  • tFold (float or TimeDelta) – Pulsar time fold in seconds (min: 5.36870912, max: 21.47483648, default: 10.73741824).

  • nBins (int) – Number of bins (min: 16, max: 8096, default: 2048).

  • durationSec (int or TimeDelta) – Observation duration in seconds (default: 0).

Added in version 1.2.0.

__init__(_setFromParset=False, **kwargs)[source]

Methods

__init__([_setFromParset])

fromParset(parset)

Returns a PulsarFoldConfig instance in which UnDySPuTeD Pulsar-FOLD observation configuration properties are set as defined by the parset.

Attributes

dsTime

Downsampling, can take values in [1, 2, 4, 8, 16, 32, 64, 128]

durationSec

freqRes

nBins

nBits

nChannels

nMAs

nPolars

nSubBands

tFold

timeRes

volume

Computes an estimation of the data volume of an UnDySPuTeD Pulsar-FOLD observation file.

property dsTime

Downsampling, can take values in [1, 2, 4, 8, 16, 32, 64, 128]

property durationSec
property freqRes
classmethod fromParset(parset)[source]

Returns a PulsarFoldConfig instance in which UnDySPuTeD Pulsar-FOLD observation configuration properties are set as defined by the parset.

Parameters:

parset (str or Parset) – Observation parset file.

Returns:

UnDySPuTeD Pulsar-FOLD configuration as defined by the parset file.

Return type:

PulsarFoldConfig

Example:
>>> from nenupy.observation import PulsarFoldConfig
>>> foldconf = PulsarFoldConfig.fromParset('nenufar_obs.parset')
property nBins
property nBits
property nChannels
property nMAs
property nPolars
property nSubBands
property tFold
property timeRes
property volume

Computes an estimation of the data volume of an UnDySPuTeD Pulsar-FOLD observation file.

Getter:

Data volume.

Type:

Quantity

Example:
>>> from nenupy.observation import PulsarFoldConfig
>>> foldconf = PulsarFoldConfig(
        durationSec=3600
    )
>>> foldconf.volume
1.9317667 Gibyte
>>> from nenupy.observation import PulsarFoldConfig
>>> foldconf = PulsarFoldConfig.fromParset(
        'nenufar_obs.parset'
    )
>>> foldconf.volume
XXX Gibyte