Selection
Configuration for the selection.
Classes¶
Bases: BaseModel
Configuration for the selection.
Attributes¶
class-attribute
instance-attribute
¶
enabled: bool = Field(default=False, description='Whether to apply detectability.')
Whether to apply detectability.
class-attribute
instance-attribute
¶
method: Literal['snr'] = Field(default='snr', description='Method to apply detectability.')
Method to apply detectability.
class-attribute
instance-attribute
¶
arguments: dict = Field(default_factory=dict, description='Arguments for the method to apply detectability.')
Arguments for the method to apply detectability.
Functions¶
classmethod
¶
validate_enabled(value: bool) -> bool
Validate the field 'enabled'.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
Value of 'enabled'. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
Value of 'enabled'. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If value is True. |