odin-detector/odin-data

View on GitHub
python/src/odin_data/control/live_view_adapter.py

Summary

Maintainability
C
1 day
Test Coverage

File live_view_adapter.py has 325 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""ODIN data live view adapter.

This module implements an odin-control adapter capable of rendering odin-data live
view images to users.

Severity: Minor
Found in python/src/odin_data/control/live_view_adapter.py - About 3 hrs to fix

    Function render_image has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        def render_image(self, colormap=None, clip_min=None, clip_max=None):
            """
            Render an image from the image data, applying a colormap to the greyscale data.
    
            :param colormap: Desired image colormap. if None, uses the default colormap.
    Severity: Minor
    Found in python/src/odin_data/control/live_view_adapter.py - About 45 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function __init__ has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def __init__(self, endpoints, default_colormap):
            """
            Initialise the LiveViewer object.
    
            This method creates the IPC channel used to receive images from odin-data and
    Severity: Minor
    Found in python/src/odin_data/control/live_view_adapter.py - About 35 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

            if (clip_array[0] is None) or isinstance(clip_array[0], int):
                self.clip_min = clip_array[0]
    Severity: Major
    Found in python/src/odin_data/control/live_view_adapter.py and 1 other location - About 1 hr to fix
    python/src/odin_data/control/live_view_adapter.py on lines 344..345

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 45.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

            if (clip_array[1] is None) or isinstance(clip_array[1], int):
                self.clip_max = clip_array[1]
    Severity: Major
    Found in python/src/odin_data/control/live_view_adapter.py and 1 other location - About 1 hr to fix
    python/src/odin_data/control/live_view_adapter.py on lines 341..342

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 45.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    There are no issues that match your filters.

    Category
    Status