Struct BrainRegion 

pub struct BrainRegion {
    pub region_id: RegionID,
    pub name: String,
    pub region_type: RegionType,
    pub cortical_areas: HashSet<CorticalID>,
    pub properties: HashMap<String, Value>,
}

Brain region metadata (genome representation)

A brain region is a hierarchical grouping of cortical areas that share functional or anatomical characteristics. Regions form a tree structure where each region can contain multiple cortical areas and sub-regions.

Design Notes

• Regions are organizational constructs (not physical entities)
• Used for genome editing, visualization, and bulk operations
• Serializable for genome persistence
• Properties stored as HashMap for maximum flexibility

Fields

region_id: RegionID

Unique identifier for this region

name: String

Human-readable name (mapped to “title” in genome JSON)

region_type: RegionType

Functional/anatomical type

cortical_areas: HashSet<CorticalID>

Set of cortical area IDs contained in this region

properties: HashMap<String, Value>

Additional user-defined properties Commonly used keys: description, coordinate_2d, coordinate_3d, inputs, outputs, signature

Implementations

impl BrainRegion

pub fn new( region_id: RegionID, name: String, region_type: RegionType, ) -> Result<BrainRegion, FeagiDataError>

Create a new brain region

Arguments

• region_id - Unique identifier (validated RegionID)
• name - Human-readable name
• region_type - Functional type

Errors

Returns error if name is empty

pub fn with_areas( self, areas: impl IntoIterator<Item = CorticalID>, ) -> BrainRegion

Create a region with initial cortical areas

pub fn with_properties(self, properties: HashMap<String, Value>) -> BrainRegion

Create a region with custom properties

pub fn add_area(&mut self, area_id: CorticalID) -> bool

Add a cortical area to this region

Returns true if the area was newly added, false if it was already present

pub fn remove_area(&mut self, area_id: &CorticalID) -> bool

Remove a cortical area from this region

Returns true if the area was present and removed, false if it wasn’t present

pub fn contains_area(&self, area_id: &CorticalID) -> bool

Check if this region contains a specific cortical area

pub fn get_all_areas(&self) -> Vec<&CorticalID>

Get all cortical area IDs in this region

pub fn area_count(&self) -> usize

Get the number of cortical areas in this region

pub fn clear_areas(&mut self)

Clear all cortical areas from this region

pub fn get_property(&self, key: &str) -> Option<&Value>

Get a property value by key

pub fn add_property(&mut self, key: String, value: Value)

Add a property to the region

pub fn to_dict(&self) -> Value

Convert to dictionary representation (for serialization)

Trait Implementations

impl Clone for BrainRegion

fn clone(&self) -> BrainRegion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrainRegion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BrainRegion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BrainRegion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.