Skip to main content

Config

Struct Config 

Source
pub struct Config<'a> {
    pub levels: &'a [usize],
    pub lambdas: &'a [f32],
    pub is_geo: bool,
    pub max_cost: f32,
    pub window_size: i32,
    pub outer_window: i32,
    pub offsets: (usize, usize),
    pub window_mode: WindowMode,
    pub pa_to_pa: bool,
}
Expand description

Settings of one connectivity call. Config::default() gives the Python defaults, with level 1 included as the core requires.

Fields§

§levels: &'a [usize]

Overview levels in base pixels per overview cell: powers of two forming a continuous sequence that includes 1, such as [1, 2, 4, 8, 16, 32], in any order.

§lambdas: &'a [f32]

Dispersal kernel bandwidths in kilometres; the output is the mean of their scores. An empty slice scores every evaluated cell 0.

§is_geo: bool

Whether transforms are geographic (degrees) rather than projected (metres).

§max_cost: f32

Relative cost of crossing a fully degraded cell: a cell with traversal value t has path weight (1 - max_cost) * t + max_cost, so t = 1 costs 1 and t = 0 costs max_cost.

§window_size: i32

Odd window size of every level but the coarsest. The level-L annulus spans L * window_size / 2 to L * window_size base pixels from the focal pixel centre, and level 1 is the disc of radius window_size; in square mode these are half-widths.

§outer_window: i32

Odd window size of the coarsest level L, whose annulus reaches L * outer_window base pixels. Values below window_size use window_size.

§offsets: (usize, usize)

Global (row0, col0) of the tile’s top-left pixel in the full raster, in base pixels; (0, 0) for a whole raster.

§window_mode: WindowMode

Circular or square annuli.

§pa_to_pa: bool

PARC target gating: only protected destinations, weighted by each overview cell’s protected fraction (unmasked share of its valid pixels), count in the connectedness numerator. Paths and the denominator are unchanged, and a focal cell that reaches no protected destination scores 0. For BERI it only makes focal cells without neighbours score 0; Python’s beri() never sets it.

Trait Implementations§

Source§

impl<'a> Clone for Config<'a>

Source§

fn clone(&self) -> Self

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<'a> Copy for Config<'a>

Source§

impl<'a> Debug for Config<'a>

Source§

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

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

impl Default for Config<'_>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<'a> Freeze for Config<'a>

§

impl<'a> RefUnwindSafe for Config<'a>

§

impl<'a> Send for Config<'a>

§

impl<'a> Sync for Config<'a>

§

impl<'a> Unpin for Config<'a>

§

impl<'a> UnsafeUnpin for Config<'a>

§

impl<'a> UnwindSafe for Config<'a>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.