BioLib.Images Class Reference

Static Public Member Functions
static BioImage	GetImage (string ids)
static void	AddImage (BioImage im)
static int	GetImageCountByName (string s)
static string	RemoveExtensions (string file)
	Removes extensions from filename including multiple extensions like .ome.tif.
static string	GetExtensions (string file)
	Return extensions of a file including multiple extensions like .ome.tif.
static string	GetImageName (string s)
	Get a unique image name from a string.
static void	RemoveImage (BioImage im)
static void	RemoveImage (string id)
static void	UpdateImage (BioImage im)

Static Public Attributes
static List< BioImage >	images = new List<BioImage>()

Member Function Documentation

AddImage()

static void BioLib.Images.AddImage ( BioImage im )

static

It adds an image to the list of images

Parameters

BioImage

A class that contains the image data and other information.

        {
            if (images.Contains(im))
                return;
            foreach (var item in Images.images)
            {
                if (im.Filename.Contains(item.Filename))
                    return;
            }
            im.Filename = im.Filename.Split(' ')[0];
            images.Add(im);
        }

GetExtensions()

static string BioLib.Images.GetExtensions ( string file )

static

Return extensions of a file including multiple extensions like .ome.tif.

Parameters

file

Returns

        {
            string[] ex = file.Split(".");
            if (ex.Length == 1)
                return "." + ex[0];
            else
            if (ex.Length > 2)
                return "." + ex[ex.Length - 2] + "." + ex[ex.Length - 1];
            else
                return "." + ex.Last();
        }

GetImage()

static BioImage BioLib.Images.GetImage ( string ids )

static

Parameters

ids	The id of the image you want to get.

        {
            ids = ids.Replace("\\", "/");
            for (int i = 0; i < images.Count; i++)
            {
                if (images[i].ID.Contains(System.IO.Path.GetFileName(ids)) || images[i].Filename == System.IO.Path.GetFileName(ids))
                    return images[i];
            }
            return null;
        }

GetImageCountByName()

static int BioLib.Images.GetImageCountByName ( string s )

static

It takes a string as an argument, and returns the number of times that string appears in the list of images

Parameters

s	The name of the image

Returns

The number of images that contain the name of the image.

        {
            int i = 0;
            s = RemoveExtensions(s);
            if (s.Contains("-"))
            {
                string ss = RemoveExtensions(s.Substring(s.LastIndexOf("-"), s.Length - s.LastIndexOf("-")));
                s = ss;
            }
            for (int im = 0; im < images.Count; im++)
            {
                if (images[im].ID.Contains(s))
                    i++;
            }
            return i;
        }

GetImageName()

static string BioLib.Images.GetImageName ( string s )

static

Get a unique image name from a string.

Parameters

s

Returns

        {
            //Here we create a unique ID for an image.
            int i = Images.GetImageCountByName(s);
            if (i == 0)
                return Path.GetFileName(s);
            string name = RemoveExtensions(s);
            string ext = GetExtensions(s);
            if (name.EndsWith("-" + i))
                name = name.Substring(name.LastIndexOf('-'), name.Length - name.LastIndexOf('-'));
            return name + "-" + (i + 1) + ext;
        }

RemoveExtensions()

static string BioLib.Images.RemoveExtensions ( string file )

static

Removes extensions from filename including multiple extensions like .ome.tif.

Parameters

file

Returns

        {
            return System.IO.Path.GetFileNameWithoutExtension(System.IO.Path.GetFileNameWithoutExtension(file));
        }

RemoveImage() [1/2]

static void BioLib.Images.RemoveImage ( BioImage im )

static

This function removes an image from the table

Parameters

BioImage

This is the image that you want to remove.

        {
            RemoveImage(im.Filename);
        }

RemoveImage() [2/2]

static void BioLib.Images.RemoveImage ( string id )

static

It removes an image from the table

Parameters

id	The id of the image to remove.

Returns

The image is being returned.

        {
            BioImage im = GetImage(id);
            if (im == null)
                return;
            images.Remove(im);
            im.Dispose();
        }

UpdateImage()

static void BioLib.Images.UpdateImage ( BioImage im )

static

It updates an image from the table

Parameters

id	The id of the image to update.
im	The BioImage to update with.

Returns

The image is being returned.

        {
            for (int i = 0; i < images.Count; i++)
            {
                if (images[i].ID == im.ID)
                {
                    images[i] = im;
                    return;
                }
            }
        }

Member Data Documentation

images

List<BioImage> BioLib.Images.images = new List<BioImage>()

static

---

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

• BioLib/Source/Bio.cs