HyperCube
HyperCube

Reputation: 3950

Specify figure size in centimeter in matplotlib

I am wondering whether you can specify the size of a figure in matplotlib in centimeter. At the moment I write:

def cm2inch(value):
    return value/2.54

fig = plt.figure(figsize=(cm2inch(12.8), cm2inch(9.6)))

But is there a native approach?

Upvotes: 50

Views: 52486

Answers (4)

Florian
Florian

Reputation: 142

Perhaps you can define your own figure method. It's not very elegant, but it avoids having to specify cm all the time. This can of course also be adapted to other typical pyplot figures like plt.subplots, etc.

def figure(**kwargs):
    """
    create a figure with figsize in cm
    """
    cm = 1/2.56  # convert cm to inch

    kwargs = dict(**kwargs)
    figsize = kwargs.pop("figsize", (15*cm, 10*cm))
    figsize = (figsize[0]*cm, figsize[1]*cm)

    fig = plt.figure(figsize=figsize, **kwargs)
    return fig

figure(figsize=(12.8,9.6))

returns Figure(500x375)

Upvotes: 0

aignas
aignas

Reputation: 1074

This is not an answer to the question ''Is there a native way?'', but I think that there is a more elegant way:

def cm2inch(*tupl):
    inch = 2.54
    if isinstance(tupl[0], tuple):
        return tuple(i/inch for i in tupl[0])
    else:
        return tuple(i/inch for i in tupl)

Then one can issue plt.figure(figsize=cm2inch(12.8, 9.6)), which I think is a much cleaner way. The implementation also allows us to use cm2inch((12.8, 9.6)), which I personally do not prefer, but some people may do.


Even though there isn't any way of doing this natively at the moment, I found a discussion here.

Upvotes: 34

wolfrevo
wolfrevo

Reputation: 7303

As far as I know, matplotlib doesn't have any conversion functions.

If you often need to convert units, you could consider using pint. It also offers NumPy support.

For your example, you could do something like the following:

from pint import UnitRegistry
ureg = UnitRegistry()

width_cm, height_cm = (12.8 * ureg.centimeter, 9.6 * ureg.centimeter)
width_inch, height_inch = (width_cm.to(ureg.inch), height_cm.to(ureg.inch))

figsize_inch = (width_inch.magnitude, height_inch.magnitude)
fig = plt.figure(figsize=figsize_inch)

Upvotes: 1

Sam Macharia
Sam Macharia

Reputation: 1241

I think the solution provided here is also helpful. So, in your case,

cm = 1/2.54  # centimeters in inches
plt.figure(figsize=(12.8*cm, 9.6*cm))

Upvotes: 14

Related Questions