Skip to content

File parameter models

This file contains data classes for parameters of spoc data structures

ContactsParameters

Bases: GlobalParameters

Parameters for multiway contacts

Source code in spoc/models/file_parameter_models.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
class ContactsParameters(GlobalParameters):
    """Parameters for multiway contacts"""

    @classmethod
    def get_uri_fields(cls) -> List[str]:
        """Returns the fields that should be included in the URI"""
        # Specific parameters needed to enforce order
        return [
            "number_fragments",
            "metadata_combi",
            "binary_labels_equal",
            "symmetry_flipped",
            "label_sorted",
        ]

get_uri_fields() classmethod

Returns the fields that should be included in the URI

Source code in spoc/models/file_parameter_models.py 
40
41
42
43
44
45
46
47
48
49
50
@classmethod
def get_uri_fields(cls) -> List[str]:
    """Returns the fields that should be included in the URI"""
    # Specific parameters needed to enforce order
    return [
        "number_fragments",
        "metadata_combi",
        "binary_labels_equal",
        "symmetry_flipped",
        "label_sorted",
    ]

GlobalParameters

Bases: BaseModel

Base class for global file parameters

Source code in spoc/models/file_parameter_models.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class GlobalParameters(BaseModel):
    """Base class for global file parameters"""

    number_fragments: Optional[int] = None
    metadata_combi: Optional[Tuple[str, ...]] = None
    label_sorted: bool = False
    binary_labels_equal: bool = False
    symmetry_flipped: bool = False

    @classmethod
    def get_uri_fields(cls) -> List[str]:
        """Returns the fields that should be included in the URI"""
        raise NotImplementedError

    def __hash__(self) -> int:
        # get metadata hash
        return hash(
            (
                self.number_fragments,
                self.metadata_combi,
                self.label_sorted,
                self.binary_labels_equal,
                self.symmetry_flipped,
            )
        )

get_uri_fields() classmethod

Returns the fields that should be included in the URI

Source code in spoc/models/file_parameter_models.py 
19
20
21
22
@classmethod
def get_uri_fields(cls) -> List[str]:
    """Returns the fields that should be included in the URI"""
    raise NotImplementedError

PixelParameters

Bases: GlobalParameters

Parameters for genomic pixels

Source code in spoc/models/file_parameter_models.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class PixelParameters(GlobalParameters):
    """Parameters for genomic pixels"""

    binsize: Optional[int] = None
    same_chromosome: bool = True

    @classmethod
    def get_uri_fields(cls) -> List[str]:
        """Returns the fields that should be included in the URI"""
        # Specific parameters needed to enforce order
        return [
            "number_fragments",
            "binsize",
            "metadata_combi",
            "binary_labels_equal",
            "symmetry_flipped",
            "label_sorted",
            "same_chromosome",
        ]

    def __hash__(self) -> int:
        return hash(
            (
                self.number_fragments,
                self.binsize,
                self.metadata_combi,
                self.label_sorted,
                self.binary_labels_equal,
                self.symmetry_flipped,
                self.same_chromosome,
            )
        )

get_uri_fields() classmethod

Returns the fields that should be included in the URI

Source code in spoc/models/file_parameter_models.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
@classmethod
def get_uri_fields(cls) -> List[str]:
    """Returns the fields that should be included in the URI"""
    # Specific parameters needed to enforce order
    return [
        "number_fragments",
        "binsize",
        "metadata_combi",
        "binary_labels_equal",
        "symmetry_flipped",
        "label_sorted",
        "same_chromosome",
    ]