cw-weave-models (OctApps Reference Manual)

2.10 `cw-weave-models`

Function File: hgrm = WeaveFstatMismatch ( opt, val, … )

Estimate the F-statistic mismatch distribution of lalapps_Weave.

Options

EITHER

setup_file: Weave setup file

OR

coh_Tspan: time span of coherent segments
semi_Tspan: total time span of semicoherent search

sky

Whether to include search over sky parameters (default: true)

spindowns

Number of spindown parameters being searched

lattice

Type of lattice used by search (default: Ans)

coh_max_mismatch

semi_max_mismatch

Maximum coherent and semicoherent mismatches; for a single- segment or non-interpolating search, set coh_max_mismatch=0

Outputs

hgrm: Histogram of F-statistic mismatch distribution

Examples

try
  lal; lalpulsar;
catch
  disp("skipping test: LALSuite bindings not available"); return;
end_try_catch
results = fitsread(fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits"));
args = struct;
args.setup_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_setup_file.fits");
args.spindowns = results.primary.header.nspins;
args.coh_max_mismatch = str2double(results.primary.header.progarg_coh_max_mismatch);
args.semi_max_mismatch = str2double(results.primary.header.progarg_semi_max_mismatch);
hgrm = fevalstruct(@WeaveFstatMismatch, args);
assert(meanOfHist(hgrm), 0.0876, 1e-3);

Function File: [ SFT_freq_min, SFT_freq_max ] = WeaveInputSFTBand ( opt, val, … )

Estimate the input SFT band required by lalapps_Weave

Arguments

SFT_freq_min/max: Minimum/maximum SFT frequency range

Options

EITHER

setup_file: Weave setup file

OR

segment_list: Segment list
ref_time: GPS reference time

EITHER

result_file: Weave result file

OR

freq_min/max: Minimum/maximum frequency range
f1dot_min/max: Minimum/maximum 1st spindown
f2dot_min/max: Minimum/maximum 2nd spindown (optional)

TSFT

Length of an SFT (default: 1800s)

Dterms

Number of Dirichlet terms used by the F-statistic (default: 8)

run_med_win

Size of running median window used by the F-statistic (default: 101)

Examples

try
  lal; lalpulsar;
catch
  disp("skipping test: LALSuite bindings not available"); return;
end_try_catch
results = fitsread(fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits"));
args = struct;
args.setup_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_setup_file.fits");
args.result_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits");
[SFT_freq_min, SFT_freq_max] = fevalstruct(@WeaveInputSFTBand, args);
assert(SFT_freq_min <= min([results.segment_info.data.sft_min_freq]));
assert(SFT_freq_max >= max([results.segment_info.data.sft_max_freq]));

Function File: setup = WeaveReadSetup ( setup_file )

Returns pre-parsed setup file as a struct with additional fields:

‘segment_list’: Nx2 array of segment GPS [ start-times ; end-times ]
‘segment_props’: pre-parsed segment properties returned by AnalyseSegmentList()
‘Nsegments’: number of segments
‘Ndetectors’: number of detectors
‘detectors’: cell-array of detector-names
‘ref_time’: reference GPS time
‘start_time’: first segment start time
‘coh_Tspan’: average segment length (=coherent length)
‘semi_Tspan’: total time-span of segment list

Examples

setup_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_setup_file.fits");
setup = WeaveReadSetup(setup_file);
assert(isstruct(setup));

Function File: [ times, maxmem, tau ] = WeaveRunTime ( opt, val, … )

Estimate the run time and maximum memory usage of lalapps_Weave.

Options

EITHER

setup_file: Weave setup file

OR

Nsegments: number of segments
Ndetectors: number of detectors
ref_time: GPS reference time
start_time: GPS start time
coh_Tspan: time span of coherent segments
semi_Tspan: total time span of semicoherent search

EITHER

result_file: Weave result file

OR

freq_min/max: minimum/maximum frequency range
dfreq: frequency spacing
f1dot_min/max: minimum/maximum 1st spindown
f2dot_min/max: minimum/maximum 2nd spindown (optional)
Fmethod: F-statistic method used by search
Ncohres: total number of computed coherent results
Nsemitpl: number of computed semicoherent results
cache_max: maximum size of coherent results cache

stats

Comma-separated list of statistics being computed

timings

the name of a Weave result file to read fundamental timing constants from, or else the string "default" to use default timings

TSFT

Length of an SFT (default: 1800s)

Outputs

times.total: estimate of total CPU run time (seconds)
times.‘field’: estimate of CPU time (seconds) to perform action ‘field’; see the script itself for further documentation
maxmem.total: estimate of maximum total memory usage (MB)
maxmem.‘field’: estimate of maximum memory usage (MB) of component ‘field’; see the script itself for further documentation
tau.‘field’: fundamental timing constants

Examples

try
  lal; lalpulsar;
catch
  disp("skipping test: LALSuite bindings not available"); return;
end_try_catch
results = fitsread(fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits"));
args = struct;
args.setup_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_setup_file.fits");
args.result_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits");
args.stats = "sum2F,mean2F,log10BSGL,log10BSGLtL,log10BtSGLtL";
[times, maxmem, tau] = fevalstruct(@WeaveRunTime, args);
assert(times.total > 0);
assert(maxmem.total > 0);
assert(all(structfun(@(t) t > 0, tau)));

Function File: depth = WeaveSensDepth ( opt, val, … )

Estimate the sensitivity depth of lalapps_Weave.

Options

EITHER

setup_file: Weave setup file

OR

Nsegments: number of segments
detectors: comma-separated list of detectors
coh_Tspan: time span of coherent segments
semi_Tspan: total time span of semicoherent search

alpha

delta

If not searching over sky parameters, give sky point of search (default: all-sky)

spindowns

Number of spindown parameters being searched

lattice

Type of lattice used by search (default: Ans)

coh_max_mismatch

semi_max_mismatch

Maximum coherent and semicoherent mismatches; for a single- segment or non-interpolating search, set coh_max_mismatch=0

NSFTs

total number of SFTs used by search

pFD

false dismissal probability of search

EITHER

pFA: false alarm probability of search
semi_ntmpl: number of semicoherent templates used by search

OR

mean2F_th: threshold on mean 2F
TSFT: Time span of a single SFT (default: 1800 seconds)

Outputs

depth: estimated sensitivity depth
mismatch_hgrm: mismatch histogram

Examples

try
  lal; lalpulsar;
catch
  disp("skipping test: LALSuite bindings not available"); return;
end_try_catch
results = fitsread(fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits"));
args = struct;
args.setup_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_setup_file.fits");
args.spindowns = results.primary.header.nspins;
args.coh_max_mismatch = str2double(results.primary.header.progarg_coh_max_mismatch);
args.semi_max_mismatch = str2double(results.primary.header.progarg_semi_max_mismatch);
args.NSFTs = results.primary.header.nsfts;
args.pFA = 0.01;
args.semi_ntmpl = results.primary.header.nsemitpl;
depth = fevalstruct(@WeaveSensDepth, args);
assert(depth, 29.573, 0.1);

Function File: [ coh_Nt, semi_Nt, dfreq ] = WeaveTemplateCount ( opt, val, … )

Estimate the number of templates computed by lalapps_Weave

Arguments

coh_Nt: number of coherent templates
semi_Nt: number of semicoherent templates
dfreq: frequency spacing

Options

EITHER

setup_file: Weave setup file

OR

Nsegments: Number of segments
detectors: Comma-separated list of detectors
ref_time: GPS reference time
coh_Tspan: Time span of coherent segments
semi_Tspan: Total time span of semicoherent search

EITHER

result_file: Weave result file

OR

sky_area: Area of sky to cover (4*pi = entire sky)
freq_min/max: Minimum/maximum frequency range
f1dot_min/max: Minimum/maximum 1st spindown
f2dot_min/max: Minimum/maximum 2nd spindown (optional)
coh_max_mismatch
semi_max_mismatch: Maximum coherent and semicoherent mismatches; for a single- segment or non-interpolating search, set coh_max_mismatch=0

lattice

Type of lattice to use (default: Ans)

Examples

try
  lal; lalpulsar;
catch
  disp("skipping test: LALSuite bindings not available"); return;
end_try_catch
results = fitsread(fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits"));
args = struct;
args.setup_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_setup_file.fits");
args.result_file = fullfile(fileparts(file_in_loadpath("WeaveReadSetup.m")), "test_result_file.fits");
[coh_Nt, semi_Nt] = fevalstruct(@WeaveTemplateCount, args);
assert(coh_Nt, results.primary.header.ncohtpl, -0.2);
assert(semi_Nt, results.primary.header.nsemitpl, -0.2);

2.10 cw-weave-models

Options

Outputs

Examples

Arguments

Options

Examples

Examples

Options

Outputs

Examples

Options

Outputs

Examples

Arguments

Options

Examples

2.10 `cw-weave-models`