Command line utilities

Command line utilities#

spp_header#

Usage

spp_header [OPTIONS] COMMAND [ARGS]...

get#

Get the value of a header key.

Usage

spp_header get [OPTIONS] FILFILE

Options

-k, --key <key>#

Required A header key to read (e.g. telescope, fch1, nsamples)

Arguments

FILFILE#

Required argument

print#

Print the header information.

Usage

spp_header print [OPTIONS] FILENAME

Options

-f, --file_type <file_type>#

File type

Options:

auto | sigproc | pfits | shdf5

--long#

Print the full Header information

Arguments

FILENAME#

Required argument

update#

Update a header key.

Usage

spp_header update [OPTIONS] FILFILE

Options

-i, --item <item>#

Required (key, value) to update in header

Arguments

FILFILE#

Required argument

spp_extract#

Usage

spp_extract [OPTIONS] COMMAND [ARGS]...

bands#

Extract frequency bands from filterbank data.

Usage

spp_extract bands [OPTIONS] FILFILE

Options

-s, --chanstart <chanstart>#

Required Start channel

-n, --nchans <nchans>#

Required Number of channels to extract

-c, --chanpersub <chanpersub>#

Number of channels in each sub-band

-o, --outfile <outfile>#

Output file basename

Arguments

FILFILE#

Required argument

channels#

Extract frequency channels from filterbank data.

Usage

spp_extract channels [OPTIONS] FILFILE

Options

-c, --chans <chans>#

Required Channels to extract

-o, --outfile <outfile>#

Output file basename

Arguments

FILFILE#

Required argument

samples#

Extract time samples from filterbank data.

Usage

spp_extract samples [OPTIONS] FILFILE

Options

-s, --start <start>#

Required Start time sample

-n, --nsamps <nsamps>#

Required Number of time samples to extract

-g, --gulp <gulp>#

Number of samples to read at once

-o, --outfile <outfile>#

Output filename

Arguments

FILFILE#

Required argument

spp_clean#

Clean RFI from filterbank data.

Usage

spp_clean [OPTIONS] FILFILE

Options

-m, --method <method>#

RFI cleaning method to use.

Options:

mad | iqrm

-t, --threshold <threshold>#

Sigma threshold for RFI cleaning.

-g, --gulp <gulp>#

Number of samples to read at once

-o, --outfile <outfile>#

Output masked filterbank file

-s, --maskfile <maskfile>#

Output mask file

Arguments

FILFILE#

Required argument