adjustoffset

Description:

Adjust the offset of a rapidtide delay map.

Inputs:

A rapidtide delay map.

Outputs:

A new rapidtide delay map, with a different time offset.

Usage:

Adjust the offset of a rapidtide delay map.

usage: adjustoffset [-h] [--includemask MASK[:VALSPEC]]
                    [--excludemask MASK[:VALSPEC]] [--extramask MASK]
                    [--searchrange LAGMIN LAGMAX] [--histbins BINS]
                    [--histonly] [--display] [--pickleft]
                    [--pickleftthresh THRESH] [--setoffset OFFSET]
                    [--norefine] [--debug]
                    inputmap outputroot

Positional Arguments

inputmap

The name of the rapidtide maxtime map.

outputroot

The root name for the output files.

Named Arguments

--searchrange

Limit fit to a range of lags from LAGMIN to LAGMAX. Default is -10 to 20 seconds.

Default: (-10, 20)

--histbins

Number of bins in the entropy histogram (default is 151).

Default: 151

--histonly

Only calculate offset histograms - do not perform adjustments.

Default: False

--display

Show the delay histogram.

Default: False

--pickleft

Choose the leftmost peak of the histogram that exceeds the threshold.

Default: False

--pickleftthresh

Fraction of the maximum height that can be considered a peak. Default is 0.33

Default: 0.33

--setoffset

Directly set the offset value to OFFSET. Overrides histogram.

--norefine

Do not fit the histogram peak.

Default: True

--debug

Output debugging information.

Default: False

Masking options

--includemask

Only use voxels that are also in file MASK in calculating the offset values (if VALSPEC is given, only voxels with integral values listed in VALSPEC are used).

--excludemask

Do not use voxels that are also in file MASK in calculating the offset values (if VALSPEC is given, voxels with integral values listed in VALSPEC are excluded).

--extramask

Additional mask to apply to select voxels for adjustment. Zero voxels in this mask will be excluded. If not specified, the corrfit_mask will be used.