Struct numcodecs_uniform_noise::UniformNoiseCodec

pub struct UniformNoiseCodec {
    pub scale: f64,
    pub seed: u64,
}

Codec that adds seeded U(-scale/2, scale/2) uniform noise of the given scale during encoding and passes through the input unchanged during decoding.

This codec first hashes the input array data and shape to then seed a pseudo-random number generator that generates the uniform noise. Therefore, passing in the same input with the same seed will produce the same noise and thus the same encoded output.

Fields

scale: f64

Scale of the uniform noise, which is sampled from U(-scale/2, +scale/2)

seed: u64

Seed for the random noise generator

Trait Implementations

impl Clone for UniformNoiseCodec

fn clone(&self) -> UniformNoiseCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec for UniformNoiseCodec

type Error = UniformNoiseCodecError

Error type that may be returned during encodeing and decodeing.

fn encode(&self, data: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Encodes the data and returns the result.

fn decode(&self, encoded: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Decodes the encoded data and returns the result.

fn decode_into( &self, encoded: AnyArrayView<'_>, decoded: AnyArrayViewMut<'_>, ) -> Result<(), Self::Error>

Decodes the encoded data and writes the result into the provided decoded output.

impl<'de> Deserialize<'de> for UniformNoiseCodec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for UniformNoiseCodec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn always_inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for UniformNoiseCodec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticCodec for UniformNoiseCodec

const CODEC_ID: &'static str = "uniform-noise"

Codec identifier.

type Config<'de> = UniformNoiseCodec

Configuration type, from which the codec can be created infallibly.

fn from_config(config: Self::Config<'_>) -> Self

Instantiate a codec from its configuration.

fn get_config(&self) -> StaticCodecConfig<'_, Self>

Get the configuration for this codec.