Skip to main content

ExportOptions

Struct ExportOptions 

Source
#[non_exhaustive]
pub struct ExportOptions {
Show 17 fields pub tile_size: u32, pub overwrite: bool, pub max_prepared_frame_bytes: u64, pub transfer_syntax: TransferSyntax, pub jpeg_direct_htj2k_profile: JpegDirectHtj2kProfile, pub jpeg_quality: u8, pub icc_profile_policy: IccProfilePolicy, pub uid_policy: UidPolicy, pub encode_backend: EncodeBackendPreference, pub codec_validation: CodecValidation, pub source_device_decode: bool, pub j2k_decomposition_levels: Option<u8>, pub gpu_encode_inflight_tiles: Option<usize>, pub gpu_encode_memory_mib: Option<u64>, pub gpu_pipeline_depth: Option<usize>, pub gpu_row_batch_rows: Option<usize>, pub gpu_row_batch_target_tiles: Option<usize>,
}
Expand description

Options controlling how a source WSI should be converted into DICOM.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§tile_size: u32

Target DICOM tile size in pixels for generated frames.

§overwrite: bool

Whether generated DICOM files may replace existing files.

§max_prepared_frame_bytes: u64

Maximum prepared uncompressed frame buffer size in bytes.

§transfer_syntax: TransferSyntax

Requested output transfer syntax.

§jpeg_direct_htj2k_profile: JpegDirectHtj2kProfile

Direct JPEG-to-HTJ2K profile used when eligible.

§jpeg_quality: u8

JPEG quality used for JPEG Baseline fallback encoding.

§icc_profile_policy: IccProfilePolicy

ICC profile policy for missing source color metadata.

§uid_policy: UidPolicy

Policy for generated Study, Series, SOP, and related DICOM UIDs.

§encode_backend: EncodeBackendPreference

Runtime encoder backend preference.

§codec_validation: CodecValidation

Runtime codec validation policy.

§source_device_decode: bool

Whether source tile decode may use a device backend when available.

§j2k_decomposition_levels: Option<u8>

Optional maximum JPEG 2000 decomposition level override.

§gpu_encode_inflight_tiles: Option<usize>

Optional cap on concurrently in-flight GPU encode tiles.

§gpu_encode_memory_mib: Option<u64>

Optional GPU encode memory budget in MiB.

§gpu_pipeline_depth: Option<usize>

Optional GPU pipeline depth.

§gpu_row_batch_rows: Option<usize>

Optional maximum rows per GPU row batch.

§gpu_row_batch_target_tiles: Option<usize>

Optional target tile count per GPU row batch.

Implementations§

Source§

impl ExportOptions

Source

pub fn lossless_review() -> Self

Return reviewer-focused lossless export options.

Source

pub fn fast_jpeg(tile_size: u32, jpeg_quality: u8) -> Self

Return fast JPEG Baseline export options for speed-oriented comparisons.

Source§

impl ExportOptions

Source

pub fn validate(&self) -> Result<(), Error>

Validate option combinations before running an export.

Trait Implementations§

Source§

impl Clone for ExportOptions

Source§

fn clone(&self) -> ExportOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExportOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ExportOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ExportOptions

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ExportOptions

Source§

impl PartialEq for ExportOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ExportOptions

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ExportOptions

Auto Trait Implementations§

Blanket Implementations§

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more