Command line utilities#

spp_header#

spp_header [OPTIONS] COMMAND [ARGS]...

get#

Get the value of a header key.

spp_header get [OPTIONS] FILFILE

Options

-k, --key <key>#

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

Arguments

FILFILE#

Required argument

print#

Print the header information.

spp_header print [OPTIONS] FILFILE

Arguments

FILFILE#

Required argument

update#

Update a header key.

spp_header update [OPTIONS] FILFILE

Options

-i, --item <item>#

(key, value) to update in header

Arguments

FILFILE#

Required argument

spp_decimate#

Reduce time and/or frequency resolution of filterbank data.

spp_decimate [OPTIONS] FILFILE

Options

-t, --tfactor <tfactor>#

Number of time samples to add

-c, --ffactor <ffactor>#

Number of frequency channels to add

-g, --gulp <gulp>#

Number of samples to read at once

-o, --outfile <outfile>#

Output filename

Arguments

FILFILE#

Required argument

spp_extract#

spp_extract [OPTIONS] COMMAND [ARGS]...

bands#

Extract frequency bands from filterbank data.

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

Arguments

FILFILE#

Required argument

channels#

Extract frequency channels from filterbank data.

spp_extract channels [OPTIONS] FILFILE

Options

-c, --chans <chans>#

Channels to extract

Arguments

FILFILE#

Required argument

samples#

Extract time samples from filterbank data.

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.

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

--save, --no-save#

Save the mask information to a file

Arguments

FILFILE#

Required argument