Skip to content

objdetdatadescription

objdetdatadescription

Module for ObjDetDataDescription

Classes

ObjDetDataDescription dataclass

Bases: OutputObjDetDataDescription, InputImageDataDescription

The default implementation for OutputObjDetDataDescription

Functions
get_anchor_aspect_ratios 
get_anchor_aspect_ratios()

Returns the aspect ratio of the anchors

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
58
59
60
def get_anchor_aspect_ratios(self) -> List[float]:
    """Returns the aspect ratio of the anchors"""
    return self.anchor_aspect_ratios
get_anchor_scales 
get_anchor_scales()

Returns the scale of the anchors

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
62
63
64
def get_anchor_scales(self) -> List[float]:
    """Returns the scale of the anchors"""
    return self.anchor_scales
get_anchorcount_for_scale 
get_anchorcount_for_scale(scale)

Calculates the anchor count for one feature map

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
32
33
34
35
36
def get_anchorcount_for_scale(self, scale: int) -> int:
    """Calculates the anchor count for one feature map"""
    feature_width: int = self.input_image_size.width // scale
    feature_height: int = self.input_image_size.height // scale
    return feature_height * feature_width * self.get_anchorcount_per_feature()
get_anchorcount_per_feature 
get_anchorcount_per_feature()

Returns the number of anchors per feature

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
42
43
44
def get_anchorcount_per_feature(self) -> int:
    """Returns the number of anchors per feature"""
    return len(self.anchor_scales) * len(self.anchor_aspect_ratios)
get_base_area_side 
get_base_area_side()

Returns the base area side of the anchors

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
66
67
68
def get_base_area_side(self) -> float:
    """Returns the base area side of the anchors"""  # QUEST: what is this?
    return self.anchor_base_area_side
get_box_variance 
get_box_variance()

Returns variance of bounding boxes

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
28
29
30
def get_box_variance(self) -> List[float]:
    """Returns variance of bounding boxes"""
    return self.box_variance
get_coordinates_count 
get_coordinates_count()

Returns the number of coordinates of bounding boxes

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
38
39
40
def get_coordinates_count(self) -> int:
    """Returns the number of coordinates of bounding boxes"""
    return self.coordinates_count
get_featuremap_scales 
get_featuremap_scales()

Returns the scale of feature maps

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
46
47
48
def get_featuremap_scales(self) -> List[int]:
    """Returns the scale of feature maps"""
    return self.featuremap_scales
get_input_channel_count 
get_input_channel_count()

Returns the number of input channels

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
54
55
56
def get_input_channel_count(self) -> int:
    """Returns the number of input channels"""
    return self.input_channel_count
get_input_image_size 
get_input_image_size()

Returns the size of the input image(s)

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
50
51
52
def get_input_image_size(self) -> ImageSize:
    """Returns the size of the input image(s)"""
    return self.input_image_size
get_output_class_names 
get_output_class_names()

Returns the names of the output classes

Source code in niceml/data/datadescriptions/objdetdatadescription.py 
70
71
72
def get_output_class_names(self) -> List[str]:
    """Returns the names of the output classes"""
    return self.classes