Commit 9d611723 authored by Samuel Debionne's avatar Samuel Debionne Committed by Generic Bliss account for Control Software
Browse files

[SMX] Add FAI parameters description / documentation

parent 644506fa
Pipeline #75369 passed with stages
in 9 minutes and 7 seconds
......@@ -64,16 +64,16 @@ namespace processing::pipelines
// clang-format off
BOOST_ANNOTATE_MEMBER(gain_pedestal_params, gain_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "gain path"),
(doc, "The path to the gain HDF5 file"))
BOOST_ANNOTATE_MEMBER(gain_pedestal_params, pedestal_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "pedestal path"),
(doc, "The path to the pedestal HDF5 file"))
BOOST_ANNOTATE_MEMBER(gain_pedestal_params, photon_energy,
(desc, "todo"),
(doc, "TODO"))
(desc, "photon energy"),
(doc, "The photon enegy [KeV]"))
// clang-format on
BOOST_DESCRIBE_STRUCT(fai_params, (),
......@@ -84,88 +84,88 @@ namespace processing::pipelines
// clang-format off
BOOST_ANNOTATE_MEMBER(fai_params, error_model,
(desc, "todo"),
(doc, "TODO"))
(desc, "error model"),
(doc, "The error model used [poisson, azimuthal]"))
BOOST_ANNOTATE_MEMBER(fai_params, variance_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "variance path"),
(doc, "The path to the variance data"))
BOOST_ANNOTATE_MEMBER(fai_params, mask_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "mask path"),
(doc, "The mask to the variance data [masked value = 1]"))
BOOST_ANNOTATE_MEMBER(fai_params, dark_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "dark path"),
(doc, "The path to the variance data"))
BOOST_ANNOTATE_MEMBER(fai_params, dark_variance_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "dark variance path"),
(doc, "The path to the dark variance data"))
BOOST_ANNOTATE_MEMBER(fai_params, flat_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "flat path"),
(doc, "The path to the flat data"))
BOOST_ANNOTATE_MEMBER(fai_params, solid_angle_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "solid angle path"),
(doc, "The path to the solid angle data"))
BOOST_ANNOTATE_MEMBER(fai_params, polarization_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "polarization path"),
(doc, "The path to the polarization data"))
BOOST_ANNOTATE_MEMBER(fai_params, absorption_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "absorption path"),
(doc, "The path to the absorption data"))
BOOST_ANNOTATE_MEMBER(fai_params, dummy,
(desc, "todo"),
(doc, "TODO"))
(desc, "dummy"),
(doc, "The nodata value"))
BOOST_ANNOTATE_MEMBER(fai_params, delta_dummy,
(desc, "todo"),
(doc, "TODO"))
(desc, "delta_dummy"),
(doc, "A delta headroom around the nodata value"))
BOOST_ANNOTATE_MEMBER(fai_params, normalization_factor,
(desc, "todo"),
(doc, "TODO"))
(desc, "normalization factor"),
(doc, "A normalization factor applied to all pixels"))
BOOST_ANNOTATE_MEMBER(fai_params, csr_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "csr path"),
(doc, "The path to the CSR matrix file"))
BOOST_ANNOTATE_MEMBER(fai_params, cutoff_clip,
(desc, "todo"),
(doc, "TODO"))
(desc, "cutoff_clip"),
(doc, "Cutoff value of sigma-clipping"))
BOOST_ANNOTATE_MEMBER(fai_params, cycle,
(desc, "todo"),
(doc, "TODO"))
(desc, "cycle"),
(doc, "Max number of cycle of sigma-clipping"))
BOOST_ANNOTATE_MEMBER(fai_params, radius2d_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "radius2d path"),
(doc, "The path to the radius2d data"))
BOOST_ANNOTATE_MEMBER(fai_params, radius1d_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "radius1d path"),
(doc, "The path to the radius1d data"))
BOOST_ANNOTATE_MEMBER(fai_params, noise,
(desc, "todo"),
(doc, "TODO"))
(desc, "noise"),
(doc, "The path to the radius1d data"))
BOOST_ANNOTATE_MEMBER(fai_params, cutoff_pick,
(desc, "todo"),
(doc, "TODO"))
(desc, "cutoff_pick"),
(doc, "Cutoff value of peak finding"))
BOOST_ANNOTATE_MEMBER(fai_params, acc_update_freq,
(desc, "todo"),
(doc, "TODO"))
(desc, "acc update freq"),
(doc, "The number of frames when the accumulators are transferred to host"))
BOOST_ANNOTATE_MEMBER(fai_params, cl_source_path,
(desc, "todo"),
(doc, "TODO"))
(desc, "cl_source_path"),
(doc, "The path to the OpenCL kernels"))
// clang-format on
BOOST_DESCRIBE_STRUCT(proc_params, (),
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment