Struct Sample 

pub struct Sample {

    pub id: Option<SampleID>,
    pub group: Option<String>,
    pub sequence_name: Option<String>,
    pub sequence_uuid: Option<String>,
    pub sequence_description: Option<String>,
    pub frame_number: Option<u32>,
    pub uuid: Option<String>,
    pub image_name: Option<String>,
    pub image_url: Option<String>,
    pub width: Option<u32>,
    pub height: Option<u32>,
    pub date: Option<DateTime<Utc>>,
    pub source: Option<String>,
    pub location: Option<Location>,
    pub degradation: Option<String>,
    pub files: Vec<SampleFile>,
    pub annotations: Vec<Annotation>,
}

A sample in a dataset, typically representing a single image with metadata and optional sensor data.

Each sample has a unique ID, image reference, and can include additional sensor data like LiDAR, radar, or depth maps. Samples can also have associated annotations.

Fields

id: Option<SampleID>

group: Option<String>

Dataset split (train, val, test) - stored in Arrow metadata, not used for directory structure. API field name discrepancy: samples.populate2 expects “group”, but samples.list returns “group_name”.

sequence_name: Option<String>

sequence_uuid: Option<String>

sequence_description: Option<String>

frame_number: Option<u32>

uuid: Option<String>

image_name: Option<String>

image_url: Option<String>

width: Option<u32>

height: Option<u32>

date: Option<DateTime<Utc>>

source: Option<String>

location: Option<Location>

Camera location and pose (GPS + IMU data). Serialized as “sensors” for API compatibility with populate endpoint.

degradation: Option<String>

Image degradation type (blur, occlusion, weather, etc.).

files: Vec<SampleFile>

Additional sensor files (LiDAR, radar, depth maps, etc.). When deserializing from samples.list: Vec When serializing for samples.populate2: HashMap<String, String> (file_type -> filename)

annotations: Vec<Annotation>

Implementations

impl Sample

pub fn new() -> Self

Creates a new empty sample.

pub fn id(&self) -> Option<SampleID>

pub fn name(&self) -> Option<String>

pub fn group(&self) -> Option<&String>

pub fn sequence_name(&self) -> Option<&String>

pub fn sequence_uuid(&self) -> Option<&String>

pub fn sequence_description(&self) -> Option<&String>

pub fn frame_number(&self) -> Option<u32>

pub fn uuid(&self) -> Option<&String>

pub fn image_name(&self) -> Option<&str>

pub fn image_url(&self) -> Option<&str>

pub fn width(&self) -> Option<u32>

pub fn height(&self) -> Option<u32>

pub fn date(&self) -> Option<DateTime<Utc>>

pub fn source(&self) -> Option<&String>

pub fn location(&self) -> Option<&Location>

pub fn files(&self) -> &[SampleFile]

pub fn annotations(&self) -> &[Annotation]

pub fn with_annotations(self, annotations: Vec<Annotation>) -> Self

pub fn with_frame_number(self, frame_number: Option<u32>) -> Self

pub async fn download( &self, client: &Client, file_type: FileType, ) -> Result<Option<Vec<u8>>, Error>

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl Default for Sample

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sample

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Sample

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

Formats the value using the given formatter.

impl Serialize for Sample

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

where __S: Serializer,

Serialize this value into the given Serde serializer.