Enum BrightnessUnit 

pub enum BrightnessUnit {
    JyPerBeam,
    Kelvin,
}

Brightness unit of an image, determining whether flux scaling applies after convolution to a larger beam.

Variants

JyPerBeam

Jy/beam (or any per-beam flux density) — apply the Gaussian flux-scaling factor so the output stays in the same units.

Kelvin

Kelvin (brightness temperature) — surface brightness is conserved under convolution, so the scaling factor is 1.

Implementations

impl BrightnessUnit

pub fn parse(bunit: &str) -> Option<Self>

Classify a FITS BUNIT string, returning None if the unit is not recognised (neither a Kelvin nor a Jy/beam form).

Examples

use convolve_rs::BrightnessUnit;

assert_eq!(BrightnessUnit::parse("Jy/beam"), Some(BrightnessUnit::JyPerBeam));
assert_eq!(BrightnessUnit::parse(" K "), Some(BrightnessUnit::Kelvin));
assert_eq!(BrightnessUnit::parse("Jy/pixel"), None);

pub fn from_bunit(bunit: &str) -> Self

Classify a FITS BUNIT string. Anything recognised as a brightness temperature (Kelvin) skips flux scaling; recognised Jy/beam forms get the Gaussian factor. Unrecognised units cannot be determined automatically: a warning is emitted and Jy/beam is assumed.

Trait Implementations

impl Clone for BrightnessUnit

fn clone(&self) -> BrightnessUnit

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BrightnessUnit

impl Debug for BrightnessUnit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BrightnessUnit

fn default() -> BrightnessUnit

Returns the “default value” for a type.

impl Eq for BrightnessUnit

impl PartialEq for BrightnessUnit

fn eq(&self, other: &BrightnessUnit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BrightnessUnit