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:
- Hue-based wedge selection: Determines which hue wedge contains the color
- 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: MechanicalWedgeSystemMechanical 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
impl IsccNbsClassifier
Sourcepub fn new() -> Result<Self, MunsellError>
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");Sourcepub fn from_csv(csv_path: &str) -> Result<Self, MunsellError>
pub fn from_csv(csv_path: &str) -> Result<Self, MunsellError>
Create a new ISCC-NBS classifier from external CSV file.
Sourcepub fn classify_munsell(
&self,
hue: &str,
value: f64,
chroma: f64,
) -> Result<Option<ColorMetadata>, MunsellError>
pub fn classify_munsell( &self, hue: &str, value: f64, chroma: f64, ) -> Result<Option<ColorMetadata>, MunsellError>
Classify a Munsell color using the ISCC-NBS system.
Sourcepub fn find_all_colors_at_point(
&self,
hue: &str,
value: f64,
chroma: f64,
) -> Result<Vec<u16>, MunsellError>
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.
Sourcepub fn classify(
&self,
hue: &str,
value: f64,
chroma: f64,
) -> Option<ColorMetadata>
pub fn classify( &self, hue: &str, value: f64, chroma: f64, ) -> Option<ColorMetadata>
Classify a Munsell color using the ISCC-NBS system (convenience method).
Sourcepub fn classify_with_details(
&self,
hue: &str,
value: f64,
chroma: f64,
) -> Option<(ColorMetadata, String)>
pub fn classify_with_details( &self, hue: &str, value: f64, chroma: f64, ) -> Option<(ColorMetadata, String)>
Classify a Munsell color with detailed error information.
Sourcepub fn get_polygon_in_wedge(
&self,
hue: &str,
expected_descriptor: &str,
) -> Option<&IsccNbsColor>
pub fn get_polygon_in_wedge( &self, hue: &str, expected_descriptor: &str, ) -> Option<&IsccNbsColor>
Get a polygon by its expected descriptor and hue wedge
Sourcepub fn classify_munsell_color(
&self,
munsell: &MunsellColor,
) -> Result<Option<ColorMetadata>, MunsellError>
pub fn classify_munsell_color( &self, munsell: &MunsellColor, ) -> Result<Option<ColorMetadata>, MunsellError>
Classify a MunsellColor object using the ISCC-NBS system.
Sourcepub 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.
pub fn classify_srgb( &self, rgb: [u8; 3], ) -> Result<Option<ColorMetadata>, MunsellError>
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.
Sourcepub 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.
pub fn classify_lab( &self, lab: [f64; 3], ) -> Result<Option<ColorMetadata>, MunsellError>
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.
Sourcepub 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.
pub fn classify_hex( &self, hex: &str, ) -> Result<Option<ColorMetadata>, MunsellError>
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§
impl Freeze for IsccNbsClassifier
impl RefUnwindSafe for IsccNbsClassifier
impl Send for IsccNbsClassifier
impl Sync for IsccNbsClassifier
impl Unpin for IsccNbsClassifier
impl UnwindSafe for IsccNbsClassifier
Blanket Implementations§
Source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
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) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
Source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
Source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
Source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
Source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
Source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
Source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters when converting.Source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self into C, using the provided parameters.Source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
Source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
Source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
Source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle.Source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
Source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other into Self, while performing the appropriate scaling,
rounding and clamping.Source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
Source§fn into_angle(self) -> U
fn into_angle(self) -> U
T.Source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
Source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters when converting.Source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self into C, using the provided parameters.Source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
Source§fn into_color(self) -> U
fn into_color(self) -> U
Source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
Source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
Source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self into T, while performing the appropriate scaling,
rounding and clamping.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
Source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors fails to cast.Source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
Source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
Source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds error is returned which contains
the unclamped color. Read more