Welcome to DeepSphere’s documentation!

deepsphere package

Subpackages

deepsphere.data package

Subpackages
deepsphere.data.datasets package
Submodules
deepsphere.data.datasets.dataset module
Module contents
deepsphere.data.transforms package
Submodules
deepsphere.data.transforms.transforms module
Module contents
Module contents

deepsphere.layers package

Subpackages
deepsphere.layers.samplings package
Submodules
deepsphere.layers.samplings.equiangular_pool_unpool module
deepsphere.layers.samplings.healpix_pool_unpool module
deepsphere.layers.samplings.icosahedron_pool_unpool module
Module contents

DeepSphere Base Documentation doc

Submodules
deepsphere.layers.chebyshev module
Module contents

deepsphere.models package

Subpackages
deepsphere.models.spherical_unet package
Submodules
deepsphere.models.spherical_unet.decoder module
deepsphere.models.spherical_unet.encoder module
deepsphere.models.spherical_unet.unet_model module
deepsphere.models.spherical_unet.utils module
Module contents
Module contents

deepsphere.utils package

Submodules
deepsphere.utils.initialization module
deepsphere.utils.laplacian_funcs module
deepsphere.utils.parser module

Command Line Parser realated functions. One function creates the parser. Another function allows hybird usage of: - a yaml file with predefined parameters and - user inputted parameters through the command line.

deepsphere.utils.parser.create_parser()[source]

Creates a parser with all the variables that can be edited by the user.

Returns

a parser for the command line

Return type

parser

deepsphere.utils.parser.parse_config(parser)[source]

Takes the yaml file given through the command line Adds all the yaml file parameters, unless they have already been defined in the command line. Checks all values have been set else raises a Value error. :param parser: parser to be updated by the yaml file parameters :type parser: argparse.parser

Raises

ValueError – All fields must be set in the yaml config file or in the command line. Raises error if value is None (was not set).

Returns

parsed args of the parser

Return type

dict

deepsphere.utils.samplings module

Different samplings require various calculations. The calculations present here are for equiangular, healpix, icosahedron samplings.

deepsphere.utils.samplings.equiangular_bandwidth(nodes)[source]

Calculate the equiangular bandwidth based on input nodes

Parameters

nodes (int) – the number of nodes should be a power of 4

Returns

the corresponding bandwidth

Return type

int

deepsphere.utils.samplings.equiangular_calculator(tensor, ratio)[source]

From a 3D input tensor and a known ratio between the latitude dimension and longitude dimension of the data, reformat the 3D input into a 4D output while also obtaining the bandwidth.

Parameters

  • tensor (torch.tensor) – 3D input tensor

  • ratio (float) – the ratio between the latitude and longitude dimension of the data

Returns

4D tensor, the bandwidths for lat. and long.

Return type

torch.tensor, int, int

deepsphere.utils.samplings.equiangular_dimension_unpack(nodes, ratio)[source]

Calculate the two underlying dimensions from the total number of nodes

Parameters

  • nodes (int) – combined dimensions

  • ratio (float) – ratio between the two dimensions

Returns

separated dimensions

Return type

int, int

deepsphere.utils.samplings.healpix_resolution_calculator(nodes)[source]

Calculate the resolution of a healpix graph for a given number of nodes.

Parameters

nodes (int) – number of nodes in healpix sampling

Returns

resolution for the matching healpix graph

Return type

int

deepsphere.utils.samplings.icosahedron_nodes_calculator(order)[source]

Calculate the number of nodes corresponding to the order of an icosahedron graph

Parameters

order (int) – order of an icosahedron graph

Returns

number of nodes in icosahedron sampling for that order

Return type

int

deepsphere.utils.samplings.icosahedron_order_calculator(nodes)[source]

Calculate the order of a icosahedron graph for a given number of nodes.

Parameters

nodes (int) – number of nodes in icosahedron sampling

Returns

order for the matching icosahedron graph

Return type

int

deepsphere.utils.stats_extractor module
Module contents

Module contents

DeepSphere Base Documentation doc

deepsphere.tests package

Submodules

deepsphere.tests.test_foo module

Fake file to test the doc

class deepsphere.tests.test_foo.TestFoo(methodName='runTest')[source]

Bases: unittest.case.TestCase

Fake test class in order to setup the tests module

test_foo()[source]

Fake test method in order to setup the test module

Module contents

The tests module contains different directory and files that have the goal to test different parts of the code

Class

You can see in this module the TestFoo that contain the different method:

TestFoo.test_foo()

Fake test method in order to setup the test module

More Doc / Example

You can add then more doc and even examples

More info

So many info

Indices and tables