AMBER_SELECTOR(7)

πŸ“¦
version 4.4.3 Β· 2 versions
, in debian bookworm, ubuntu noble

✨ NAME ✨

amber_selector β€” the AMBER OI frame selector πŸ’…

(yes bestie, this whole page lives in the amber recipes manual section, and it's about picking which frames get to stay πŸŽ€)


🌸 SYNOPSIS 🌸

esorex amber_selector [OPTIONS] FILE.sof

πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so here's the vibe: this recipe selects frames that are stored inside an AMBER OI product, using a bunch of different methods, and then writes out a filtered OI product. Slay. 🫢

Once you've picked a method, you can set a selection criteria for every baseline by defining the variables X1, X2, and X3. And if you only have one baseline available, then X2 and X3 can be neglected β€” they're just not the moment, and that's fine πŸ’–

You also get to choose how the single criteria get combined, by setting the Boolean variable ANDselection. Two whole moods:

  • If ANDselection is not set (--ANDselection=FALSE), a frame passes the filter if at least one of the selection criteria (X1 || X2 || X3) is fulfilled. It's giving "any one of you can carry this" 😌
  • If ANDselection is set (--ANDselection=TRUE), a frame passes the filter only if ALL the selection criteria (X1 && X2 && X3) are fulfilled. No shortcuts, everyone shows up πŸ’€

And if AverageFrames is set (--AverageFrames=TRUE), the final product will contain the average of the frames ✨

⚠️ Please note, that for three baselines in both cases the visibility triplet is written to the product file! Not optional, not a maybe. The triplet is coming with you. 😭

πŸ’– Input files πŸ’–

  • SCIENCE_REDUCED β€” Type: Products β€” Explanation: OI-Fits file
  • or SCIENCE_REDUCED_FILTERED β€” Type: Products β€” Explanation: OI-Fits file
  • or CALIB_REDUCED β€” Type: Products β€” Explanation: OI-Fits file
  • or CALIB_REDUCED_FILTERED β€” Type: Products β€” Explanation: OI-Fits file
  • or SCIENCE_CALIBRATED β€” Type: Products β€” Explanation: OI-Fits file

Required: Y (yep, you need one of these, no cap πŸŽ€)

🌈 Output files 🌈

  • SCIENCE_REDUCED_FILTERED β€” Data type: Products β€” Explanation: filtered OI-fits file
  • or CALIB_REDUCED_FILTERED β€” Data type: Products β€” Explanation: filtered OI-fits file

πŸ’… OPTIONS πŸ’…

  • --selection-method <str> β€” Selection methods (str; default: Β΄Fringe_SNR_gt_xΒ΄). The full name of this option for the EsoRex configuration file is amber.amber_selector.selection_method [default = Fringe_SNR_gt_x]. πŸ‘‘
  • --X1 <float> β€” X1 Value (float; default: 2.0). The full name of this option for the EsoRex configuration file is amber.amber_selector.selection_x1 [default = 2.0]. πŸ“
  • --X2 <float> β€” X2 Value (float; default: 2.0). The full name of this option for the EsoRex configuration file is amber.amber_selector.selection_x2 [default = 2.0]. πŸ“
  • --X3 <float> β€” X3 Value (float; default: 2.0). The full name of this option for the EsoRex configuration file is amber.amber_selector.selection_x3 [default = 2.0]. πŸ“
  • --ANDselection <bool> β€” X1, X2, and X3 combining method (bool; default: False). The full name of this option for the EsoRex configuration file is amber.amber_selector.selection_ANDselection [default = False]. 🧚
  • --AverageFrames <bool> β€” Average all frames after selection (bool; default: False). The full name of this option for the EsoRex configuration file is amber.amber_selector.selection_AverageFrames [default = False]. ✨
πŸ’‘ Note that it is possible to create a configuration file containing these options, along with suitable default values. Please refer to the details provided by the esorex --help command. (iykyk 🫢)

πŸ”₯ SEE ALSO πŸ”₯

The full documentation for the amber pipeline can be downloaded as a PDF file using the following URL:

ftp://ftp.eso.org/pub/dfs/pipelines/amber/amber-pipeline-manual-4.4.3.pdf

An overview over the existing ESO pipelines can be found on the web page https://www.eso.org/sci/software/pipelines/.

Basic documentation about the EsoRex program can be found at the esorex (1) man page.

It is possible to call the pipelines from python using the python-cpl package. See https://packages.python.org/python-cpl/index.html for further information. 🐍

The other recipes of the amber pipeline are amber_BeamPos(7), amber_SciCal(7), amber_ascii_export(7), amber_calibrate(7), amber_detector(7), amber_oimerge(7), amber_p2vm(7), amber_raw_to_fitsimage(7), amber_spectral_calibration(7), amber_trf(7) β€” the whole friend group, literally πŸ’œ


⭐ VERSION ⭐

amber_selector 4.4.3 πŸŽ€


🌸 AUTHOR 🌸

Armin Gabasch <https://support.eso.org> πŸ‘‘


πŸ’€ BUG REPORTS πŸ’€

Please report any problems to https://support.eso.org. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. (they're nice, don't be shy 🫢)


πŸŽ€ LICENSE πŸŽ€

(the page doesn't spell out any license text here, bestie β€” it just goes straight to the footer 🌈)


okay and that's the whole page! this one's amber_selector, version 4.4.3, straight out of the amber recipes manual β€” mwah, no notes πŸ’…βœ¨

πŸ“¦ where this page comes from