BioImager.ChannelsTool Class Reference

Inheritance diagram for BioImager.ChannelsTool:

Public Member Functions
void	UpdateItems ()
	It clears the listbox and then adds all the items in the Channels list to the listbox.
	ChannelsTool (List< Channel > Channels)
void	RefreshHistogram ()

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used.

Properties
List< Channel >	Channels [get]
Channel	SelectedChannel [get]
int	SelectedSample [get, set]

Detailed Description

Definition at line 4 of file ChannelsTool.designer.cs.

Constructor & Destructor Documentation

ChannelsTool()

BioImager.ChannelsTool.ChannelsTool

(

List< Channel >

Channels

)

Definition at line 68 of file ChannelsTool.cs.

        {
            initializing = true;
            InitializeComponent();
            foreach (Channel item in Channels)
            {
                channelsBox.Items.Add(item);
            }
            MouseWheel += new System.Windows.Forms.MouseEventHandler(ChannelsTool_MouseWheel);
 
            if (Channels.Count == 0)
            {
                channelsBox.Enabled = false;
                sampleBox.Enabled = false;
                statsPanel.Controls.Add(new Label
                {
                    Dock = DockStyle.Fill,
                    Text = "No channel metadata is available for this image.",
                    TextAlign = ContentAlignment.MiddleCenter
                });
                initializing = false;
                return;
            }
 
            channelsBox.SelectedIndex = 0;
            Channel channel = Channels[0];
            int sample = channel.range?.Length > 0 ? 0 : -1;
            int defaultMax = channel.BitsPerPixel <= 8 ? byte.MaxValue : ushort.MaxValue;
            int minimum = sample >= 0 ? channel.range[sample].Min : 0;
            int maximum = sample >= 0 ? channel.range[sample].Max : defaultMax;
            if (channel.stats?.Length > 0)
            {
                minimum = (int)channel.stats[0].StackMin;
                maximum = (int)channel.stats[0].StackMax;
            }
            minBox.Value = Math.Clamp(minimum, (int)minBox.Minimum, (int)minBox.Maximum);
            maxBox.Value = Math.Clamp(maximum, (int)maxBox.Minimum, (int)maxBox.Maximum);
            hist = new HistogramControl(channel);
            hist.GraphMax = Math.Max(1, (int)maxBox.Value);
            maxGraphBox.Value = Math.Clamp(maxBox.Value, maxGraphBox.Minimum, maxGraphBox.Maximum);
            statsPanel.Controls.Add(hist);
            initializing = false;
            Shown += async (_, _) => await EnsureHistogramAsync();
        }

Member Function Documentation

Dispose()

override void BioImager.ChannelsTool.Dispose ( bool disposing )

protected

Clean up any resources being used.

Parameters

disposing

true if managed resources should be disposed; otherwise, false.

Definition at line 15 of file ChannelsTool.designer.cs.

        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

RefreshHistogram()

void BioImager.ChannelsTool.RefreshHistogram

(

)

Definition at line 329 of file ChannelsTool.cs.

        {
            if (Visible)
                _ = EnsureHistogramAsync();
        }

UpdateItems()

void BioImager.ChannelsTool.UpdateItems

(

)

It clears the listbox and then adds all the items in the Channels list to the listbox.

Definition at line 53 of file ChannelsTool.cs.

        {
            int selectedIndex = channelsBox.SelectedIndex;
            initializing = true;
            channelsBox.Items.Clear();
            foreach (Channel item in Channels)
            {
                channelsBox.Items.Add(item);
            }
            channelsBox.SelectedIndex = Channels.Count == 0
                ? -1
                : Math.Clamp(selectedIndex, 0, Channels.Count - 1);
            initializing = false;
        }

Property Documentation

Channels

List<Channel> BioImager.ChannelsTool.Channels

get

Definition at line 21 of file ChannelsTool.cs.

        {
            get
            {
                return App.Channels;
            }
        }

SelectedChannel

Channel BioImager.ChannelsTool.SelectedChannel

get

Definition at line 29 of file ChannelsTool.cs.

        {
            get
            {
                if (channelsBox.SelectedIndex != -1)
                    return Channels[channelsBox.SelectedIndex];
                else
                    return Channels[0];
            }
        }

SelectedSample

int BioImager.ChannelsTool.SelectedSample

getset

Definition at line 41 of file ChannelsTool.cs.

        {
            get
            {
                return (int)sampleBox.Value;
            }
            set
            {
                sampleBox.Value = (decimal)value;
            }
        }

---

The documentation for this class was generated from the following files:

• BioImager/Source/ChannelsTool.cs
• BioImager/Source/ChannelsTool.designer.cs