IsccNbsClassifier

Struct IsccNbsClassifier 

Source
pub struct IsccNbsClassifier {
    pub wedge_system: MechanicalWedgeSystem,
    /* private fields */
}
Expand description

ISCC-NBS color naming engine with deterministic boundary handling and performance caching.

This classifier translates Munsell color specifications into standardized ISCC-NBS color names using a mechanical wedge system for precise hue-based categorization and polygon containment testing.

§Architecture

The classifier uses a two-stage approach:

  1. Hue-based wedge selection: Determines which hue wedge contains the color
  2. Polygon containment testing: Tests if the (value, chroma) point falls within any color polygons in that wedge

§Thread Safety

This struct is thread-safe and can be shared across multiple threads using Arc<T>. The internal cache uses RwLock for concurrent access.

§Examples

use munsellspace::iscc::IsccNbsClassifier;

let classifier = IsccNbsClassifier::new()?;

// Classify a Munsell color specification
if let Ok(Some(color_metadata)) = classifier.classify_munsell("5R", 5.0, 12.0) {
    println!("5R 5.0/12.0 is: {}", color_metadata.iscc_nbs_descriptor());
}

Fields§

§wedge_system: MechanicalWedgeSystem

Mechanical wedge system providing deterministic hue-based classification.

Divides the complete Munsell hue circle into 100 wedge containers, each containing the relevant color polygons for that hue range.

Implementations§

Source§

impl IsccNbsClassifier

Source

pub fn new() -> Result<Self, MunsellError>

Create a new ISCC-NBS classifier using embedded color data.

Initializes the classifier by loading embedded ISCC-NBS color definitions and distributing them into a mechanical wedge system for efficient hue-based classification.

§Returns

Result containing the initialized classifier or an error if data loading fails

§Errors

Returns MunsellError::ReferenceDataError if embedded color data cannot be loaded or parsed.

§Examples
use munsellspace::IsccNbsClassifier;

let classifier = IsccNbsClassifier::new()?;
println!("Classifier initialized with embedded ISCC-NBS data");
Source

pub fn from_csv(csv_path: &str) -> Result<Self, MunsellError>

Create a new ISCC-NBS classifier from external CSV file.

Source

pub fn classify_munsell( &self, hue: &str, value: f64, chroma: f64, ) -> Result<Option<ColorMetadata>, MunsellError>

Classify a Munsell color using the ISCC-NBS system.

Source

pub fn find_all_colors_at_point( &self, hue: &str, value: f64, chroma: f64, ) -> Result<Vec<u16>, MunsellError>

Find all ISCC-NBS colors that contain a given point. Returns just the color numbers.

Source

pub fn classify( &self, hue: &str, value: f64, chroma: f64, ) -> Option<ColorMetadata>

Classify a Munsell color using the ISCC-NBS system (convenience method).

Source

pub fn classify_with_details( &self, hue: &str, value: f64, chroma: f64, ) -> Option<(ColorMetadata, String)>

Classify a Munsell color with detailed error information.

Source

pub fn get_polygon_in_wedge( &self, hue: &str, expected_descriptor: &str, ) -> Option<&IsccNbsColor>

Get a polygon by its expected descriptor and hue wedge

Source

pub fn classify_munsell_color( &self, munsell: &MunsellColor, ) -> Result<Option<ColorMetadata>, MunsellError>

Classify a MunsellColor object using the ISCC-NBS system.

Source

pub fn classify_srgb( &self, rgb: [u8; 3], ) -> Result<Option<ColorMetadata>, MunsellError>

👎Deprecated since 1.2.0: Use ColorClassifier::classify_srgb() for unified color naming. This method will be removed in v2.0.0.

Classify an sRGB color using the ISCC-NBS system.

§Deprecated

Use ColorClassifier::classify_srgb() instead for unified access to standard, extended, and semantic color names.

Source

pub fn classify_lab( &self, lab: [f64; 3], ) -> Result<Option<ColorMetadata>, MunsellError>

👎Deprecated since 1.2.0: Use ColorClassifier::classify_lab() for unified color naming. This method will be removed in v2.0.0.

Classify a Lab color using the ISCC-NBS system.

§Deprecated

Use ColorClassifier::classify_lab() instead for unified access to standard, extended, and semantic color names.

Source

pub fn classify_hex( &self, hex: &str, ) -> Result<Option<ColorMetadata>, MunsellError>

👎Deprecated since 1.2.0: Use ColorClassifier::classify_hex() for unified color naming. This method will be removed in v2.0.0.

Classify a hex color using the ISCC-NBS system.

§Deprecated

Use ColorClassifier::classify_hex() instead for unified access to standard, extended, and semantic color names.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool